lzizn/happy-api-2024

🧸 Clean Architecture 2024 version of happy-api, originally developed in 2021.

Happy - Make children's day happy

About the project   |    Technologies   |    Getting started   |   

🧸 About

Happy is an application that connects people to institutional care homes to make many children's day happier. It was originally developed in 2021.

This repository is a Clean Architecture 2024 version of happy-api.

🚀 Technologies & Concepts

Technologies & Concepts used

• Node.js
• TypeScript
• Express
• zod
• MongoDB
• AWS S3 SDK
• Swagger
• Clean Architecture

💻 Getting started

Requirements

• Node.js
• MongoDB
• Any package manager (pnpm, yarn npm)

$ git clone https://github.com/lzizn/happy-api-2024.git && cd happy-api-2024

Follow the steps below

# Starting from the project root folder, go to backend folder
# Install the dependencies
$ pnpm i

# To finish, run the api service
$ pnpm run dev

# Well done, project is started!

API documentation

Upon running the server, an api documentation is available at http://localhost/api-docs