Murillo2380/apollo-graphql-server-boilerplate

Server boilerplate with apollo graphql, tests, circle ci configured.

JS server boilerplate

The JavaScript server boilerplate with continuous integration and tests configured.

Getting started

Prerequisites

Clone the repository and run either:

yarn install

Or:

npm install

Installing

You will need to create the following file in the project root folder:

• .env - This file may contain sensitive information that should not be online. Check the .env.example file for available vars.

Then just run:

yarn start

Or:

npm run start

You may need to create the PostgreSQL database before running this project.

Running the tests

The following scripts are available (always check package.json):

    yarn test
    yarn test:circleCi
    yarn test:noForceExit
    yarn test:detectAsync
    yarn test:watch
    yarn test:coverage

The first script are configured to run before any commit. All the tests must be placed inside the src/ folder, ending with .test.ts.

Deployment

TODO

Built With

• NodeJS - Dependency Management
• Apollo Server - The JavaScript GraphQL Server.
• TypeORM - To access and manage databases.
• PostgreSQL - The database.
• Jest - For testing.

Contributing

TODO

Acknowledgments

TODO