The IT4C Boilerplate for an apollo express backends.
To be able to build this project you need nodejs, npm and optional docker.
The project sets up an apollo server. It uses type-graphql.
The following commands are available:
| Command | Description |
|---|---|
npm install |
Project setup |
npm run build |
Compiles and minifies for production |
npm run start |
Runs productions server |
| Develop | |
npm run dev |
Compiles and hot-reloads for development |
| Database | |
npm run db:migrate |
Creates and executes migrations needed |
npm run db:reset |
Drops Schema, run all migrations and seeds |
npm run db:seed |
Run the seeds |
| Test | |
npm run test:lint |
Run all linters |
npm run test:lint:eslint |
Run linter eslint |
npm run test:lint:remark |
Run linter remark |
npm run test:unit |
Run all unit tests and generate coverage report |
npm test |
Run all tests & linters |
| Documentation | |
npm run docs:dev |
Run Documentation in development mode |
npm run docs:build |
Build static documentation |
| Maintenance | |
npm run update |
Check for updates |
Docker can be run in development mode utilizing docker-compose.overwrite.yml:
docker compose upDocker can be run in production mode:
docker compose -f docker-compose.yml upYou can get a list of packes to update by running npm run update.
Appending -u will also update the packages in the package.json. You have to run npm install again after.
npm run update -- -u
npm installThe following endpoints are provided given the right command is executed or all three if docker compose is used:
| Endpoint | Description |
|---|---|
| http://localhost:4000/graphql | GraphQL API |
| http://localhost:4000/playground | GraphQL Playground |
If you want to use this as part of a larger project, e.g. in conjunction with a frontend also utilizing a boilerplate you cannot use the template mechanic provided by github for this repository.
You can use the following commands to include the whole git history of the boilerplate and be able to update according to changes to this repo using another remote.
git remote add xxx_boilerplate_backend git@github.com:IT4Change/boilerplate-backend.git
git fetch xxx_boilerplate_backend
git merge -s ours --no-commit --allow-unrelated-histories xxx_boilerplate_backend/master
git read-tree --prefix=xxx/ -u xxx_boilerplate_backend/master
git commit -m "Imported boilerplate_backend as a subtree under xxx/."To update the subtree you can use
git subtree pull -P xxx/ xxx_boilerplate_backend master
git commit -m "Updated boilerplate_backend in subtree under xxx/."Where xxx refers to the folder and product part you want to use the boilerplate in. This assumes that you might need several copies of the frontend boilerplate for you product.
This mechanic was taken from this source
The project is set up for a sqlite database.
In order to run the project against a mysql database adjust prisma/schema.prisma, copy the .env.dist file to .env and configure the database connection appropriately.
Then run npm run db:migrate to generate the database. It might be required to delete the migration folder beforehand.