An open API service indexing awesome lists of open source software.

https://github.com/riyabulia12/budgetism

Budgetism is a Ruby on Rails application that enables users to register and log in to ensure data privacy. With Budgetism, users can introduce new transactions associated with categories, as well as view the amount of money spent on each category.
https://github.com/riyabulia12/budgetism

postgresql rails rest-api ruby-on-rails tailwindcss

Last synced: 5 months ago
JSON representation

Budgetism is a Ruby on Rails application that enables users to register and log in to ensure data privacy. With Budgetism, users can introduce new transactions associated with categories, as well as view the amount of money spent on each category.

Awesome Lists containing this project

README

          

# 📖 [Budgetism]

> Budgetism is a mobile web application where user can manage their budget. User will have a list of transactions associated with a category, so that they can see how much money they spent and on what.

## 🛠 Built With

### Tech Stack

BackEnd

Test

Database

### Key Features

- **[Register and Login]** - Register and Login so the data is private to them.
- **[Transaction associated with Category]** - Transaction associated with Category.
- **[Category wise expenditure]** - See the money spent on each category.

(back to top)

## 🚀 Live Version

- [Budgetism](budgetism-production.up.railway.app)

(back to top)

## 💻 Getting Started

If you dont have Ruby installed on your computer, you can download it from [here](https://www.ruby-lang.org/en/downloads/).

If you dont have Rails installed on your computer, you can download it from [here](https://rubyonrails.org/).

If you dont have PostgreSQL installed on your computer, you can download it from [here](https://www.postgresql.org/download/).

If you have installed git you can clone the code to your machine, or download a ZIP of all the files directly.

> `NOTE:` _You may need to run the following commands in the project directory to install the required gems and run the application:_

1. Install gem packages with:

```
bundle install
```

2. Open the config/database.yml file in the project directory and change the username and password to your PostgreSQL username and password.
Edit the default section of the file to look like this:

```
default: &default
adapter: postgresql
encoding: unicode
# For details on connection pooling, see Rails configuration guide
# http://guides.rubyonrails.org/configuring.html#database-pooling
pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
username:
password:

```

3. Create the database with:

```
rails db:create
```

4. Start the development server

```
rails server
```

5. Open the app in your browser at http://localhost:3000
### Run tests

To run tests, run the following command:
rspec

(back to top)

## 👥 Authors

👤 **Riya Bulia**

- GitHub: [@RiyaBulia12](https://github.com/RiyaBulia12)
- LinkedIn: [Riya-Bulia](https://linkedin.com/in/riya-bulia)

(back to top)

## 🔭 Future Features

- [Edit and Delete Action on Category] **[Edit and Delete Action on Category]**
- [Edit and Delete Action on Transaction] **[Edit and Delete Action on Transaction]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project give as a star! ⭐️

(back to top)

## 🙏 Acknowledgments

- Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella).
- Hat tip to anyone whose code was used
- [Microverse Document](https://github.com/microverseinc/curriculum-rails/blob/main/capstone/rails_capstone.md)

(back to top)

## ❓ FAQ

- **[How I can run this project?]**

- [After cloning repository, run rails server.]

- **[Can I add likes on post?]**

- [You can add likes and comments on a post.]

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)