Node API Tutorial

This is an interactive tutorial that will teach you how to create an API with Node and Express.

🌱 How to start this project

This project comes with the necessary files to start working immediately.

We recommend opening this very same repository using a provisioning tool like Codespaces (recommended) or Gitpod. Alternatively, you can clone it on your local computer using the git clone command and follow the local installation instructions.

This is the repository you need to open:

https://github.com/breatheco-de/node-express-api-tutorial

👉 Please follow these steps on how to start a coding project.

💡 Important: Remember to save and upload your code to GitHub by creating a new repository, updating the remote (git remote set-url origin <your new url>), and uploading the code to your new repository using the add, commit and push commands from the git terminal.

About the project we are going to build

In this tutorial we are going to be building a REST API that exposes 3 endpoints to the internet:

1GET /todos
2POST /todos
3DELETE /todos/<int:position>

GET /todos

Will return the list of all todos like this:

1[
2    {
3        "done": true,
4        "label": "Sample Todo 1"
5    },
6    {
7        "done": true,
8        "label": "Sample Todo 2"
9    }
10]

POST /todos

It's going to add a new todo to the list, it will receive the following request body:

1{
2    "done": true,
3    "label": "Sample Todo 1"
4}

And return the updated list of todos.

DELETE /todos/int:position

It's going to remove one todo based on a given position at the end of the url, and return the updated list of todos.

This and many other projects are built by students as part of the 4Geeks Academy Coding Bootcamp by Alejandro Sanchez and many other contributors. Find out more about our Full Stack Developer Course, and Data Science Bootcamp.

Local Installation Instructions (optional)

Clone this repository in your local environment and follow the steps below:

1. Install LearnPack, the package manager for learning tutorials and the node compiler plugin for learnpack; make sure you also have node.js 16+:

1$ npm i @learnpack/learnpack -g

1. Start the tutorial/exercises by running the following command at the same level where your learn.json file is:

1$ learnpack start