localization-hub-api

REST API for the localization hub project. The project intends to provide a way to synchronize localization files, and streamline translation processes.

Description

This is project attempts to streamline communication between developers and translators in software projects. This is my university thesis project.

Installation

$ npm install
$ yarn

Running the app

# development
$ npm run start
$ yarn start

# watch mode
$ npm run start:dev
$ yarn start:dev

# production mode
$ npm run start:prod
$ yarn start:prod

Test

# unit tests
$ npm run test
$ yarn test

# e2e tests
$ npm run test:e2e
$ yarn test:e2e

# test coverage
$ npm run test:cov
$ yarn test:cov

Deploy server

You have to copy the compose file from the projects root directory and create a .env file next to it. You can start the server by running

docker-compose up

After deploying the project, you can retrieve your initial admin invitation by running the following command:

docker logs lohub-api_web_1 | grep invite

If prisma fails with the database, you have to initialize the database by running these commands:

docker container run --network lohub-api_lohub -it --entrypoint /bin/sh nm0829/lohub-api
export DATABASE_URL=postgresql://lohub:lohub@postgres.db:5432/lohub
yarn migrate:deploy
yarn init:rights

License

This project is GNU General Public License v2.0.