https://github.com/didaquis/didibudget-backend
Home Economics Management Application
https://github.com/didaquis/didibudget-backend
money-manager
Last synced: about 2 months ago
JSON representation
Home Economics Management Application
- Host: GitHub
- URL: https://github.com/didaquis/didibudget-backend
- Owner: didaquis
- License: mit
- Created: 2019-12-20T20:05:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-26T18:26:58.000Z (5 months ago)
- Last Synced: 2025-03-11T03:47:27.012Z (about 2 months ago)
- Topics: money-manager
- Language: JavaScript
- Homepage:
- Size: 1.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 💰 didibudget-backend
This is an app to manage your money.
The project is splitted on two repositories: one for the backend and one for the frontend application.
This repository is for the backend and is intended to work with [the frontend](https://github.com/didaquis/didibudget-frontend)
### 📝 Backend Requirements
* MongoDB 8.0 or higher
* Node.js 18.20 or higher
### 📚 How to run the application?
* Use the command: `npm install`. If you are deploying the app in production, it's better to use this command: `npm install --production`
* Configure the application:
* Duplicate the configuration file `_env` and rename it as `.env`
* Edit the file `.env`
* Then use: `npm run start`.
* That's it! That was fast enough, right? 🚀
**Do you need help with `.env` file?**
Don't worry, I have written down some information for you. Here you have a guide:
| Key | Description |
|-----|-------------|
| PORT | The port for running the backend |
| ENVIRONMENT | The mode of execution of Node.js. Choose between: production or development |
| LIMIT_USERS_REGISTERED | Maximum number of users allowed to register. Set the value to 0 to not use the limit |
| MONGO_FORMAT_CONNECTION | The format of connection with MongoDB service. Choose between: standard or DNSseedlist |
| MONGO_HOST | Set this value only if you are using the standard connection format. Host of MongoDB service |
| MONGO_PORT | Set this value only if you are using the standard connection format. Port of MongoDB service |
| MONGO_DB | Set this value only if you are using the standard connection format. The name of database |
| MONGO_USER | Set this value only if you are using the standard connection format. User name |
| MONGO_PASS | Set this value only if you are using the standard connection format. User password |
| MONGO_DNS_SEEDLIST_CONNECTION | Set this value only if you are using the DNSseedlist connection format. It should be something like this: mongodb+srv://user:password@uri-and-options |
| SECRET | JWT secret key. Remember not to share this key for security reasons |
| DURATION | JWT duration of auth token |
**How can I configure a user to be an administrator?**
To make a user an administrator you must access to the database and search its registry. You will see a Boolean who allows the user to have the role of the administrator. Set it to 'true' and in their next authentication that user will have administrator permissions.
### 💻 Tricks for development
* Run app in dev mode: `npm run dev`
* Run the linter: `npm run lint`
* Delete all log files: `npm run clean`
* Run the test, mode watch: `npm run test:watch`
### How to add default expenses categories?
To add new expense categories or subcategories, you must create a totally random and unique `inmutableKey`.
Use this snippet to obtain a new value:
```javascript
import crypto from 'crypto';
const randomValue = () => {
const numberOfBytes = 10;
return crypto.randomBytes(numberOfBytes).toString('hex');
};
randomValue();
```