Cash Flow Control backend built with Node.js

About The Project   |    Backend Technologies   |    Backend Getting Started   |    How To Contribute   |    Backend License

👨🏻‍💻 About the project

This API is a product that was created in order to help in the cash management of a store, where it is possible to create cash movements, with transactions of accounts payable and receivable. At the end of the day, the store cashier will know the total money received and the amount that came out of the cashier to maintain the life of a store.

🚀 Backend Technologies

Technologies that I used to develop this api

• Node.js
• Cors
• Express
• Swagger-Autogen
• Swagger-UI-Express
• Knex
• UUID
• Jest
• Supertest
• pg
• ESLint
• VS Code with EditorConfig and Prettier RC

💻 Backend getting started

Requirements

• Node.js
• Yarn or npm
• Docker CLI
• Docker-Compose CLI

Clone the project and access the folder

$ git clone https://github.com/eltonlazzarin/cash-flow-control.git

$ cd cash-flow-control

Follow the steps below

# Install the dependencies
$ yarn

Creating Docker environment with postgres DB

# Create docker enviroment
$ docker-compose up

Run Knex Migrates

# Create tables
$ yarn knex:migrate

Run the API

# Run the API
$ yarn dev

To access the API Go to your browser and acess http://localhost:3333/cashiers

To view the API documentation Go to your browser and access http://localhost:3000/doc

To run tests

# Drop tables
$ yarn knex:migrate:rollback

# Create tables
$ yarn knex:migrate

$ yarn test

🤔 How to contribute backend

Follow the steps below

# Clone your fork
$ git clone https://github.com/eltonlazzarin/cash-flow-control.git

$ cd cash-flow-control

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 Backend License

This project is under the MIT license. See the LICENSE for more information.

---

Made with ♥ by Elton Lazzarin 👋 Get in touch!