DavidHe1127 / birds-supply-server

:computer: Bird supply server powered by apollo-server and graphql

Bird Supply Server

A platform that connects parrot lovers and suppliers together.

Prerequisites

MongoDB

We use mongodb as the database which means to be able to run the app, you need to install mongodb server and keep it running in the background while running birds supply server.

Please ask your lovely friend Google about how to install mongodb.

How to run the app

• Run npm i from the root to install required npm dependencies
• Run npm run seed to preload sample data into mongodb
• Duplicate .env.example as .env in the same location as .env.example and populate the required services credentials
• Configure FCM as per instructions of next section
• For Mac users, run npm start For Windows users, you need to ensure your mongodb is already running at the background and run npm run win under the project root

How to configure FCM

Go to service accounts under your project settings page and click generate private key to generate and download a json credentials.

Graphiql Interface

Go to http://localhost:4000/graphiql to write and test your graphql queries

TODO

• Upgrade apollo server to 2.0

• Add relay-modern persisted queries http://www.reactjunkie.com/relay-modern-persisted-queries/

• Persist notifications into firebase db & use firebase cloud messaging to send notifications

• Integrate Graphql Apollo Engine

• Inspect to see if N+1 problem presents (dataloader comes to the rescue for this)

• overhaul queries/move public queries to under viewer node

• Add signup page/logic

• Refactor mutation design as per Graphql Mutation Deisgn

• Add validations

• Replace directiveResolvers with SchemaDirectiveVisitor

• Add subscriptions

• Add dataloader

Things can be better

• Timing Promise.all in resolvers/queries/viewer.js

Deployment

• Test containers communication locally via docker compose
• Deploy it on EC2 using ECS follow guide on effective_devops_with_aws (docker installed)

Reading

• graphql-compose-relay

Tech stack

• front-end
  • relay-modern
• back-end
  • Apollo Restify Server
• database
  • mongodb
  • mongoose