https://github.com/fif0o/books-api
Simple RESTful API using Express, Mongo as backend and Isomorphic React as a front-end layer with websockets for live notifications and redux, sagas for state management and side effects. A GraphQL implementation is also available.
https://github.com/fif0o/books-api
graphql mongodb mongoose prisma react-server-render reactjs redux redux-saga rest-api webpack websockets
Last synced: 3 months ago
JSON representation
Simple RESTful API using Express, Mongo as backend and Isomorphic React as a front-end layer with websockets for live notifications and redux, sagas for state management and side effects. A GraphQL implementation is also available.
- Host: GitHub
- URL: https://github.com/fif0o/books-api
- Owner: FiF0o
- License: mit
- Created: 2017-02-11T17:21:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-24T14:57:15.000Z (over 6 years ago)
- Last Synced: 2024-04-14T12:26:30.734Z (about 1 year ago)
- Topics: graphql, mongodb, mongoose, prisma, react-server-render, reactjs, redux, redux-saga, rest-api, webpack, websockets
- Language: JavaScript
- Homepage:
- Size: 1.24 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Books-API
This is a simple server side App offering a web API as well as a front based a [GraphQL](https://graphql.org/) & [MongoDB](https://docs.mongodb.com/manual/installation/) implementations.
- GraphQL implementation is available on the `graphql` branch as well as `master`.
- MongoDB implementation available on `mongo` branch.
The front-end uses ReactJs and Material design css with [Material Components Web](https://material.io/develop/web/docs/getting-started/) library:
- Redux for state management, Sagas for side-effects & Websocket for live updates on the `mongo` branch.
- [PrismaDB](https://www.prisma.io/), Apollo is used on the `graphql` branch to interface with graphQL.
## 1. Pre-requisites
-----------------
You must add your `DATABASE` endpoints for your environments in the `config` directory.
```
./
__config/
package.json
.env
...
```
The API is served by default on `PORT:3000`.
The Web app is served by default on `PORT:3001`.
### *1.1 Dependencies*
You must have MongoDB installed on your machine or PrismaDB.
### *1.2 Environment*
Env variables are loaded with [dotenv](https://www.npmjs.com/package/dotenv).
Before running the project don't forget to add the following variables in your `.env` file.
```
// MongoDB variables for differents environments...
DEV_DB
PROD_DB
// API endpoints, ports... for MongoDB, GraphQL
API_PORT=
// App env variables...
APP_PORT=
// Prisma DB variables: App & DB layers, Authentication/Encryption Token
PRISMA_DB_ENDPOINT=
PRISMA_DB_SECRET=
PRISMA_CLUSTER=
PRISMA_BEARER_TOKEN=
```
(_Refer_ to the `env` file for help)
### 1.3 MongoDB implementation
_[mongo shell](https://docs.mongodb.com/manual/mongo/) to test & debug._
- Runs on `PORT:3000`
- Routes & endpoints:
- `/api/books/`
- `/api/books/:id`
- `/api/genres/`
- `/api/genres/:id`
- Mongoose ODM (Schema, Controllers):
```
./
__api/
____resources/
______ /
________ index.js
________ .controller.js
________ .model.js
________ .router.js
...
______ router.js
______ index.js
```
### 1.4 GraphQL inplementation
[GraphQL](https://www.howtographql.com/), [Prisma](https://www.prisma.io/) ORM.
- Application layer (GraphQL):
```
./
__/api/
____schema.graphql
____index.js
```
- Database layer (Prisma & bindings):
```
./
__database/
____datamodel.graphql
____prisma.yml
```
_Additional documentation:_
- _[init prisma service](https://www.prisma.io/docs/tutorials/setup-prisma/demo-server-ouzia3ahqu)._
- _[deploy prisma & generated prisma.graphql](https://www.prisma.io/docs/quickstart/)._
- _[prisma API](https://www.prisma.io/docs/reference/prisma-api/overview-ohm2ouceuj/)._
## 2. Commands
- Running the project: `npm run start`
- Developing: `npm run dev`
- Running the web API: `npm run api`
- Running the web server: `npm run server`
- Bundling the artefacts: `npm run build`
- _(optional)_ mongoDB cluster: `npm run db`
## 3. Next steps
-------------
- Testing.
- CI/CD.
- Styling on the `graphql` branch.