This repository contains the source files and documentation for the API of the Coding Garden Community App. For general information about the Community App please visit the App Wiki.
There are multiple ways to run the API locally:
N/A. However in the future the API will need access to a MongoDB database.
We use the yarn package manager to run this project. If you haven't already please set up NodeJS >= 10.15.0 and yarn >= 1.13.0.
After setting up both tools you can install all dependencies by cloning this
project and running yarn install
in the local project's root directory.
Starting the API can then be done by issuing this command: yarn run dev
. You
can now visit http://localhost:3000/ to view the API.
TBD
Copy the .env.sample
file and update accordingly:
cp .env.sample .env