AlexGalhardo/todo-api-clean-architecture

ToDo API Clean Architecture

Introduction

• A simple REST API using Clean Architecture principles I build while reading the book Arquitetura Limpa Na Prática - Otávio Lemos

Technologies

• Linux Mint XFCE 21.04
• Git
• NodeJS v20
• VSCode
• TypeScript

Development Setup Local

• Clone repository

git clone https://github.com/AlexGalhardo/todo-api-clean-architecture

• Enter repository

cd todo-api-clean-architecture/

• Install dependencies

npm install

• Setup your enviroment variables

cp .env-example .env

• Start Docker, PrismaORM, Migrations and Seeds

sh setup.sh

• To Start Prisma Studio:

npm run prisma:studio

• Start local server

npm run dev

• Go to: http://localhost:4000/

Build for deploy

• To created build to deploy run:

npm run build

• To test build production locally run:

npm run start

License

MIT

Copyright (c) August 2023-present, Alex Galhardo