Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.27 KB

README.md

File metadata and controls

28 lines (20 loc) · 1.27 KB
Raw

ScoutTrek API

Apollo GraphQL schema for Boy and Girls Scout Troops to create custom events

  • Create common events such as camping, hiking, and backpacking based on ScoutTrek templates
  • Create custom event templates for your Troop and allow authorized users like Patrol Leaders to create those event types
  • Store, update, and send notifcations based on the latest changes to events, ensuring all users are up to date

Tech

  • Typescript
  • Apollo Server
  • Mongoose + Atlas MongoDB Database
  • Google Cloud App Engine

Note: Important libraries include type-graphql and typegoose, which help with types for graphql and mongoose respectively

Setting up on local

  1. Clone the repo to your local using https://github.com/ScoutTrek/event-discovery-service.git
  2. Get the .env file (reach out to a ScoutTrek developer) and add it to the root directory
  3. Reach out to a ScoutTrek developer for MongoDB and Google Cloud invite. Check notion for instructions on setting up Google Cloud.
  4. In the terminal, run yarn install
  5. Install MongoDB
  6. Run yarn start to start the server
  7. Make sure you have ScoutTrek mobile-app set up as well -- see the readme to begin developing