Apollo GraphQL with MongoDB Boilerplate
https://swap76.github.io/Apollo-GraphQL-Mongo-Boilerplate/
Documentation:This boilerplate includes following things:-
- Apollo GraphQL server creation & configuration
- MongoDB setup & Model Examples
- GraphQL schema examples
- JWT Authorization Middlewear
- REST API Configuration
Project Structure
Our project has the following structure:
- docs
- node_modules
- src
- config
- controllers
- graphql
- middleware
- models
- routes
- utils
- test
1. Docs
This contains all the markdown files for the documentation of the project, which is visualized on Docsify.
2. Node Modules
Contains project dependencies.
3. Config
This contains all the configuration files; like database connectivity, winston setup, etc.
4. Controllers
This contains all the REST API end-points.
5. GraphQL
This contains schema files, queries and mutations for GraphQL API.
6. Middleware
This contains all the middleware functions of the request-response pipeline.
7. Models
This contains all the mongoDB schema.
8. Routes
This contains all the routes for REST API.
9. Utils
This contains all the helper functions associated with other endpoints.
10. Tests
This contains basic setup for chai, mocha testing which can be integrated with Travis CI easily or any other CI
Getting Started
These instructions will get you a copy of the project up and running o# Apollo GraphQL with MongoDB Boilerplate
This boilerplate includes following things:-
- Apollo GraphQL server creation & configuration
- MongoDB setup & Model Examples
- GraphQL schema examples
- JWT Authorization Middlewear
- REST API Configuration
- Tests using Chai & Mocha
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
Following are the softwares requried to get arena up and running.
Installing
-
Install the packages mentioned in package.json file for getting all dependencies of the project.
npm install --save
-
Getting the configuration ready
cp .env.example .env
-
Starting the application
npm run dev
-
Setting the pre-push hook
./hooks.sh
Linting the Code
- For linting the code
npm run lint -s
- For fixing the linting mistakes in code
npm run fix -s
Issues
Issues are managed via GitHub Issues here.
Developers
- Swapnil Shinde - Swap76
License
This project is licensed under the Apache License. See the LICENSE.md file for details. n your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.