API

Welcome to the API wiki!

api : The NestJS API package that powers all our data (api.codementoring.co)

📦 Installation and Setup

1. Install Node.js. Check the website for information on how to install
2. Install Yarn Check the website for information on how to install
3. Clone the project. Git clone the project to somewhere you want to work on your local machine
4. Install Postgres database. This will be needed to run the project locally
5. Setup database
   1. Create a user on your new Postgres database
   2. Create a database called code_mentoring_learning in Postgres
   3. Create your local development settings file under: packages/api/config/development.yml
   4. Add the following to that file:

   db:
     username: USER YOU JUST CREATED IN POSTGRESS
     password: PASSWORD YOU USED

---

🏃🏿‍♂️ Running the project

API:

cd packages/api;
yarn dev

You can then open http://localhost:4000/graphql to test the API

---

👏 Credits

This project is built and maintained by the community of Code Mentoring.

Built by the people, for the people