plots-backend v1.0.0

Plots Backend

The Typescript GraphQL MongoDB Backend behind Plots.

Getting Started

Preqreqs

Make sure you have MongoDB installed and running. You should be able to run mongo and have it connect to your local MongoDB server.

Running the Server

To startup the server, run

yarn start

You should see:

🚀  Server ready at http://localhost:4000/

Testing

To run all E2E tests, run:

yarn test

All test cases (located under src/tests) should run!

Environment Variables

LOCAL_DB=false # Whether to use the cloud database or local, default false

Notes

This backend pulls from the GraphQL schema laid out in the Plots Shared repository. Check src/DAO/types.ts to see the generated types!

The Resolvers hold all the resolver definitions for Typescript, broken up by GraphQL Type (i.e. Event or User). The Helpers folder contains all our database modifiers.