README.md

Academy Pay

💸 Academy Pay 💸

About • Functionalities • Run the project • API Endpoints • Tecnolgies • Collaborators • Deployed version • License

💻 About the project

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.

⚙️ Functionalities

• Register user
• Register client
• Register client charges
• Validation system for dates and due dates
• Update user and client records
• General financial tracking

Web

🏃‍♀️ Run the project

🎲 Run Backend

💡 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

🧭 Run Frontend

💡 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.

📍API Endpoints

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

POST /registerUser

REQUEST

{
  "name":"User Name",
  "email":"[email protected]",
  "password": "password"
}

POST /login

REQUEST

{
  "email":"[email protected]",
  "password": "password"
}

RESPONSE

{
	"user": {
		"id": 25,
		"name": "User Name",
		"cpf": null,
		"email": "[email protected]",
		"phone": null
	},
	"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjUsImlhdCI6MTcwODk4MDA5MywiZXhwIjoxNzA5MDA4ODkzfQ.bD47unSSmt8XhtzpmCc9YykGRjB7MvMFh6g4Jvz0OLg"
}

PUT /editUser/:idUser

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": ""
		}
	]
}

POST /registerClient/:idUser

REQUEST

{
  "name":"client",
  "email":"[email protected]",
  "phone": "14122248547",
  "cpf": "462.020.777-27",
	"state":"RJ"
}

PUT /editClient/:idUser

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"
}

POST /registerBilling/:idUser/:idClient

REQUEST

{
  "status":"PENDENTE",
  "value":53000,
  "due_date":"2023-12-02"
}

PUT /editBilling/:idBill

REQUEST

{
	"name":"client",
	"value":"15590",
	"due_date":"2023-11-24",
	"status":"PAGO",
	"payment_date":"2023-11-26"
}

🛠 Tecnologies

Website (React)

• Chakra UI
• Axios
• Framer Motion
• Crypto JS
• React Router Dom

Server (NodeJS)

• Axios
• Bcript
• CORS
• dotENV
• Express
• KnexJS
• Joi
• JSON webToken

Utilities

• Figma: Figma → Prototype
• API: API
• Source-Code Editor: Visual Studio Code
• API Client: Insomnia
• Icons: Chakra Ui Icons
• Fonts: Nunito, Montserrat

---

🤝 Collaborators

This is the dream team that made it all happen: 💜

Kauane Santos

Murilo Schneider 👨‍💻

Luiz Pedro 👨‍💻

Jeferson Vieira 👨‍💻

Gabriel Navarro 👨‍💻

🚀 Deployed Application

Visit our project and try it for yourself:

🖥️Frontend 🎲Backend

📝 Licese

This project is under license MIT.

Made with 💓 by Kauane Santos 👋 Contact me!