Roommates App is a Node.js app that consists of an API RESTful that can GET, POST, UPDATE and DELETE roommates expenses. The server is built using the http module and file manipulation is made by fs. It also has the functionality to send emails to all the roommates each time a new expense is registered. The frontend is rendered dynamically by the server and is built using Bootstrap 4.5.
Backend/Frontend
- CRUD functionality for roommates expenses.
- Node Mailer used to send email notification to users when new expense is registered.
- JSON format is used for the API data.
- Coming soon...
To get a local copy up and running, follow these steps.
To run this project you need:
- Node.js
Clone this repository to your desired folder:
git clone git@github.com:jfoyarzo/RoommatesApp.git
Install this project's dependencies with:
npm install
To start the server use the following command:
node index.js
This will serve the frontend on:
http://localhost:3000
For the mailing functionality to work, valid credentials must be provided in the mailer.js file.
👤 Felipe Oyarzo
- Full calculations functionality
- Better and responsive design
- Option to opt-out from email notifications
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you like this project please give it a ⭐!
This project is MIT licensed.