mylist-api

API for mylist.

Getting Started

The following contains the steps required to get the application up and running on your local workspace. To check out the available endpoints, visit the documentation.

Prerequisites

• Node v15.14.0
• npm v7.9.0
• Git v2.31.1

Running locally

To run the app locally, follow the steps below:

1. Clone the repository to your PC using your terminal. For more info, refer to this article

2. After cloning, navigate into the repo using the command:

   cd mylist-api
   

3. Install the dependencies in the package.json using the command:

   npm install
   

4. After the dependencies have been installed successfully, create a .env file at the root. Take a look at the env.sample file and configure your environment variables with your values in the .env file.

5. After adding the environment variables, run the app in your terminal using the command:

   npm run dev