Skip to content

README.md

Latest commit

 

History

History
58 lines (35 loc) · 1.41 KB

README.md

File metadata and controls

58 lines (35 loc) · 1.41 KB

ToDo REST API ✅

This is the documentation for the ToDo REST API, which provides endpoints for to-dos.

Prod address environment

https://todo-api-h8ov.onrender.com/

Local Setup

Prerequisites

Before starting, make sure you have the following installed on your system:

  • Node.js (at least version 15)
  • npm (Node Package Manager)

Steps

Open your terminal and navigate to the directory where you want to create your project.

Clone the project repository from Github:

$ git clone git@github.com:corecodeio/todo-api.git

Navigate to the cloned repository:

$ cd todo-api

Install the required packages using npm:

$ npm install

Run the project in development mode:

$ npm run dev

This command will start your application in development mode and you should see a message in the console that says "Server started on port 8000". You can now access your application by visiting http://localhost:8000 in your web browser. You will see the documentation there.

Congratulations! You have successfully set up the project on your local machine.🎉

Online Documentation

You can find the documentation Here

For Techleads ⚠️

This repository includes inside the src/index.mjs file the use of public folder, this will be not required for the developers in the bootcamp. This is only used here to show the documentation.