Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 1.61 KB

README.md

File metadata and controls

66 lines (42 loc) · 1.61 KB

Build Status Test Coverage Maintainability

sypian server

The sypian server delivering an API.

It serves as an api to save projects, categories and their relations into a neo4j database.

The API specification is defined in the swagger.yml.

Why that naming?

Why sypian? wtf? Yeah, it means "see your projects in a network".

Development

Setup development environment

Load vendor libraries through composer and build the docker image.

make build

Run tests

First start the neo4j server which is needed for the integration tests.

make neo4j

Then run the test command.

make test

Run the linter

make lint

Deployment

Container overview

  • php: Holds the php binary and the source code of sypian.
  • nginx: Gets the source code as a volume and serves as the webserver, connected to the php container.
  • neo4j: The neo4j database connected to the php container.

Make and run deployable components

We use an environment for building the production docker image.

export SYPIAN_BUILD_ENV=production
docker run --rm --volume ${CODE_DIR}:/app composer install --ignore-platform-reqs
docker-compose build

Now you can run the containers.

docker-compose run