Carmu API

Customer data, cash movements, invoicing and statistics are managed via a RESTful API developed using Express and TypeScript. It provides robust and efficient CRUD operations, ensuring scalability and data security.

Dependencies

Dev Dependencies

This project use the next dependencies for dev

Dependencie	Description
Eslint	Use Eslint with standard rules
Prettier	For format the style code
Husky & lint-staged	For control the pre-commit

Installation

1. Clone this repository git clone https://github.com/Zuniga63/carmu-api.git
2. Install the dependencies with node pnpm install
3. Create the .env file with cp .env.example .env
4. Write the credentials to the file .env
5. After adding Cloudinary credentials run the script for create the presets pnpm run presets
6. Finished for dev run npm run dev and for production npm run start

Diagram Model

Relationship entity diadram of the models used for the API, the entities in green are implemented.

API Documentation

swagger-ui-express is used for endpoint documentation and can be found in the "/api-docs" path.