to-dos-api

It is a fake in-memory ToDos API for this UI that demonstrates a Test-Driven Development approach on how to develop a React web app using MobX and Cypress.
It contains setup for development inside of VSCode Dev Containers (just Dev Containers from now on) or without it.

More info about the project and its related repos can be found here: to-dos-documentation.

Prerequisites

If you develop inside Dev Containers

• Docker
• VSCode
• Dev Containers Extension

If you develop using good old Node.js (no Dev Containers)

• Node.js (version 20.11.1 was used but it should be also fine with some older versions, ideally install using nvm which will allow you to easily switch between Node.js versions if needed)
• VSCode (optional, you can use any IDE but VSCode has configured formatting on save by the lint rules of the project)

Start

If you open this project in VSCode please install Dev Containers extension and agree to re-open this project's folder in it with installing all the rest of recommended extensions.

# run once to install dependencies
npm ci

# to run the api and re-run on a change
npm run start:dev

# to run linting
npm run lint

Note: this is a NestJS Api that was bootstrapped using these guidelines.

Docker Build

docker build -t to-dos-api .

Docker Local Run

docker run --publish 5005:80 --rm -t to-dos-api