Project TrainSite API

This repository contains the API which will soon power the official website of The Coding Train. Brainstorming, feature suggestions and new ideas should be done at https://github.com/CodingTrain/project-trainsite instead.

---

Roadmap

This is just a very basic list of things that need to be done before we can finally go live. More features will be added along the way.

• 📑 Create basic content structure that represent the current state of the site
• 🔑 Implement authentication strategy (see KeystoneJS guides)
• 🚂 Create API endpoints for dynamic content (community contributions, etc.)
• 🐳 Set up Docker for easier local development and deployment

---

Project Setup

To setup this project locally, follow these steps:

• Fork this repository
• Install dependencies with yarn install
• Make sure you have a MongoDB instance running locally (you can try using the included docker-compose.yml to set everything up)
• Run yarn dev to run the project in development mode

Build

Build instructions will follow soon™️

---

Contributing

Contributions to this project are more than welcome! You can contribute in many different ways:

• Contribute to the codebase and submit a pull request (see CONTRIBUTING.md)
• Suggest features you'd like to see here
• Track bugs you've found related to the API here

Code of Conduct

Please refer to The Coding Train's Code of Conduct.

Licence

This project is licenced under MIT.