README.md

Backend

Installation with Docker

Run the following command to install everything through docker.

The installation takes a bit longer on the first pass or on rebuild ...

# in main folder
$ docker-compose up
# or
# rebuild the containers for a cleanup
$ docker-compose up --build

Wait a little until your backend is up and running at http://localhost:4000/.

Installation without Docker

For the local installation you need a recent version of Node (>= v16.19.0). We are using v20.12.1 and therefore we recommend to use the same version (see some known problems with more recent node versions). You can use the node version manager nvm to switch between different local Node versions:

# install Node
$ cd backend
$ nvm install v20.12.1
$ nvm use v20.12.1

Install node dependencies with yarn:

# in main folder
$ cd backend
$ yarn install
# or just
$ yarn
# or just later on to use version of ".nvmrc" file
$ nvm use && yarn

Copy Environment Variables:

# in backend/
$ cp .env.template .env

Configure the new file according to your needs and your local setup. Make sure a local Neo4J instance is up and running.

Start the backend for development with:

# in backend/
$ yarn run dev

or start the backend in production environment with:

# in backend/
$ yarn run start

For e-mail delivery, please configure at least SMTP_HOST and SMTP_PORT in your .env configuration file.

Your backend is up and running at http://localhost:4000/ This will start the GraphQL service (by default on localhost:4000) where you can issue GraphQL requests or access GraphQL Playground in the browser. More details about our GraphQL playground and how to use it with ocelot.social can be found here.

Database Indexes and Constraints

Database indexes and constraints need to be created and upgraded when the database and the backend are running:

::: tabs @tab:active Docker

# in main folder while docker-compose is running
$ docker exec backend yarn run db:migrate init

# only once: init admin user and create indexes and constraints in Neo4j database
# for development
$ docker compose exec backend yarn prod:migrate init
# in production mode use command
$ docker compose exec backend /bin/sh -c "yarn prod:migrate init"

# in main folder with docker compose running
$ docker exec backend yarn run db:migrate up

@tab Without Docker

# in folder backend/ while database is running
# make sure your database is running on http://localhost:7474/browser/
yarn run db:migrate init

# in backend/ with database running (In docker or local)
yarn run db:migrate up

:::

Seed Database

If you want your backend to return anything else than an empty response, you need to seed your database:

::: tabs @tab:active Docker

In another terminal run:

# in main folder while docker-compose is running
$ docker exec backend yarn run db:seed

To reset the database run:

# in main folder while docker-compose is running
$ docker exec backend yarn run db:reset
# you could also wipe out your neo4j database and delete all volumes with:
$ docker-compose down -v
# if container is not running, run this command to set up your database indexes and constraints
$ docker exec backend yarn run db:migrate init
# And then upgrade the indexes and const
$ docker exec backend yarn run db:migrate up

@tab Without Docker

Run:

# in backend/ while database is running
$ yarn run db:seed

To reset the database run:

# in backend/ while database is running
$ yarn run db:reset

:::

Data migrations

Although Neo4J is schema-less,you might find yourself in a situation in which you have to migrate your data e.g. because your data modeling has changed.

::: tabs @tab:active Docker

Generate a data migration file:

# in main folder while docker-compose is running
$ docker-compose exec backend yarn run db:migrate:create your_data_migration
# Edit the file in ./src/db/migrations/

To run the migration:

# in main folder while docker-compose is running
$ docker exec backend yarn run db:migrate up

@tab Without Docker

Generate a data migration file:

# in backend/
$ yarn run db:migrate:create your_data_migration
# Edit the file in ./src/db/migrations/

To run the migration:

# in backend/ while database is running
$ yarn run db:migrate up

:::

Testing

Beware: We have no multiple database setup at the moment. We clean the database after each test, running the tests will wipe out all your data!

::: tabs @tab:active Docker

Run the unit tests:

# in main folder while docker-compose is running
$ docker exec backend yarn run test

@tab Without Docker

Run the unit tests:

# in backend/ while database is running
$ yarn run test

:::