About โข Functionalities โข Run the project โข API Endpoints โข Tecnolgies โข Collaborators โข Deployed version โข License
Academy Pay is a solution designed to meet the financial management needs of commercial establishments. It provides a safe and efficient platform for registering customers and organizing the accounts associated with each of them. Owners find this tool an effective resource for transparent management and detailed monitoring of customer transactions.
- Register user
- Register client
- Register client charges
- Validation system for dates and due dates
- Update user and client records
- General financial tracking
๐ก try the deployed version: https://backend-devastados.vercel.app/
# Clone this repository:
$ git clone [email protected]:Kauanedev/academy-pay.git
# Access the project folder:
$ cd academy-pay
# Go to server folder:
$ cd server
# Install dependencies:
$ npm install
# Run the app in the development mode
$ npm run dev
# Server will start on port:3000
๐ก try the deployed version: https://desafio-final-front-dds-t12-omega.vercel.app/
# Clone this repository:
$ git clone [email protected]:Kauanedev/academy-pay.git
# Access the project folder:
$ cd academy-pay
# Go to frontend folder:
$ cd frontend
# Install dependencies:
$ npm install
# Run the app in the development mode:
$ npm run start
# Server will start on port:3000 - Open ~ http://localhost:3000 ~ to view it in your browser.
route | description |
---|---|
POST /registerUser | See request details |
POST /login | See request details |
PUT /editUser/:idUser | See request details |
GET /getUser/:idUser | Returns specific user |
POST /registerClient/:idUser | See request details |
GET /listClients/:idUser | Returns Clients |
GET /getClient/:idUser | Returns specific client |
PUT /editClient/:idUser | See request details |
POST /registerBilling/:idUser/:idClient | See request details |
PUT /editBilling/:idBill | See request details |
GET /listBills/:idUser | Returns bills from specific user |
GET /getBill/:idBill | Returns specific bill |
GET /listClientBills/:idUser/:idClient | Returns bills from specific client |
DELETE /deleteBill/:idBill | Deletes specif bill |
GET /homepage/:idUser | Returns all charges from clients of specific user |
REQUEST
{
"name":"User Name",
"email":"[email protected]",
"password": "password"
}
REQUEST
{
"email":"[email protected]",
"password": "password"
}
RESPONSE
{
"user": {
"id": 25,
"name": "User Name",
"cpf": null,
"email": "[email protected]",
"phone": null
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjUsImlhdCI6MTcwODk4MDA5MywiZXhwIjoxNzA5MDA4ODkzfQ.bD47unSSmt8XhtzpmCc9YykGRjB7MvMFh6g4Jvz0OLg"
}
REQUEST
{
"name":"User Name",
"email":"[email protected]",
"password": "password",
"cpf":"",
"phone":""
}
RESPONSE
{
"message": "Dados alterados com sucesso!",
"changePassword": true,
"data": [
{
"name": "User Name",
"email": "[email protected]",
"cpf": "",
"phone": ""
}
]
}
REQUEST
{
"name":"client",
"email":"[email protected]",
"phone": "14122248547",
"cpf": "462.020.777-27",
"state":"RJ"
}
REQUEST
{
"id":"265962",
"name": "client",
"email": "[email protected]",
"cpf": "52652352313",
"phone": "59531248129",
"zip_code": null,
"address": null,
"complementary_address": null,
"neighborhood": null,
"city": "Rio de Janeiro",
"state": "RJ"
}
REQUEST
{
"status":"PENDENTE",
"value":53000,
"due_date":"2023-12-02"
}
REQUEST
{
"name":"client",
"value":"15590",
"due_date":"2023-11-24",
"status":"PAGO",
"payment_date":"2023-11-26"
}
Website (React)
Server (NodeJS)
- Figma: Figma โ Prototype
- API: API
- Source-Code Editor: Visual Studio Code
- API Client: Insomnia
- Icons: Chakra Ui Icons
- Fonts: Nunito, Montserrat
This is the dream team that made it all happen: ๐
Kauane Santos |
Murilo Schneider ๐จโ๐ป |
Luiz Pedro ๐จโ๐ป |
Jeferson Vieira ๐จโ๐ป |
Gabriel Navarro ๐จโ๐ป |
Visit our project and try it for yourself:
This project is under license MIT.
Made with ๐ by Kauane Santos ๐ Contact me!