https://github.com/stevenselcuk/hybrid
Graphql / REST Hybrid API Boilerplate { MongoDB, Apollo, Express, JWT, Dockerized, CI / Documentation / Test Ready }
https://github.com/stevenselcuk/hybrid
api apollo apollo-server boilerplate docker express graphql heroku mongodb mongoose node nodejs rest-api starter-project starter-template
Last synced: 3 months ago
JSON representation
Graphql / REST Hybrid API Boilerplate { MongoDB, Apollo, Express, JWT, Dockerized, CI / Documentation / Test Ready }
- Host: GitHub
- URL: https://github.com/stevenselcuk/hybrid
- Owner: stevenselcuk
- Created: 2020-03-12T17:17:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T03:54:06.000Z (over 3 years ago)
- Last Synced: 2025-02-06T01:49:01.464Z (over 1 year ago)
- Topics: api, apollo, apollo-server, boilerplate, docker, express, graphql, heroku, mongodb, mongoose, node, nodejs, rest-api, starter-project, starter-template
- Language: HTML
- Homepage: https://hybridapi.herokuapp.com/
- Size: 1.69 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
hybridAPI Boilerplate (NodeJS w/GraphQL & Express)
Starting point for your next awesome API Hybrid gives you the best of both worlds REST and GraphQL with awesome stack. Just keep reading this readme file to discovering it.
---
[](https://travis-ci.com/stevenselcuk/hybrid) [](https://www.codacy.com/manual/stevenjselcuk/hybrid?utm_source=github.com&utm_medium=referral&utm_content=stevenselcuk/hybrid&utm_campaign=Badge_Grade) [](https://codeclimate.com/github/stevenselcuk/hybrid/maintainability)
Are you interested? 👀 Live Demo : [https://hybridapi.herokuapp.com/](https://hybridapi.herokuapp.com/)
REST API Documentation: [https://hybridapi.herokuapp.com/api-docs/](https://hybridapi.herokuapp.com/api-docs/) (Swagger UI)
JS Documentation: [https://hybridapi.herokuapp.com/docs](https://hybridapi.herokuapp.com/docs) (JSDoc)
# 🔥Features
### 🏭Development (w/ Reloading)
- Webpack (with Babel & Eslint Loader)
- Nodemon
- Winston for logging (console and log file)
### 🏢Building
- Webpack & Babel
### 📲Deploy
- Dockerized
- PM2
- Heroku ready
### 🧪Testing
- Mocha & Chai (with auth & user tests)
- Coverage ready with NYC
- Codecov ready
### 🚐CI
- Travis
### 📚Documentation
- Swagger UI & server
- JSDoc (a classic)
- Postman ( I ❤️it)
### 🛠Tools
- Seeding
# Tech
- Eslint
- Prettier
- Babel 7
- Webpack
- Apollo Server
- Express
- MongoDB with Mongoose
- Redis Cache (on both of REST & GrapQL)
- Multer
- Passport
- Jwt
# Start to Developing
```javascript
// Clone it
git clone https://github.com/stevenselcuk/hybrid.git
// enter folder
cd hybrid
// Install deps
yarn
// Seed admin account and other demo material
yarn seed
// For using Nodemon
yarn dev
// or using Webpack
yarn dev:webpack
// That's all
```
# Build
Build with Webpack
`yarn build`
or building with Babel
`yarn build:babel`
# Testing
`yarn test`
[](https://dashboard.heroku.com/new?template=https://github.com/stevenselcuk/hybrid.git)