Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/edi-sipka/budget_rails

Budget Rails is a mobile web application where user can manage their budget with transactions. You can check how much your are spending monthly.
https://github.com/edi-sipka/budget_rails

Last synced: 6 days ago
JSON representation

Budget Rails is a mobile web application where user can manage their budget with transactions. You can check how much your are spending monthly.

Awesome Lists containing this project

README

        

# 📖 [Budget_Rails]

> Budget Rails is a mobile web application where user can manage their budget with transactions. You can check how much your are spending monthly.

## 🛠 Built With

### Tech Stack

BackEnd

Test

Database

### Key Features

- **[Register and Login]** - Register and Login so the data is private to them.
- **[Transaction ]** - Check your transactions.

(back to top)

## :movie_camera: Video documentation
[video](https://www.loom.com/share/d759d978018b4ddebc3380abab707abe)

## 🚀 Live Version

- [Budget Rails](https://rails-bbb8.onrender.com/)

(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

👤 _Edi Sipka_

- GitHub: [@Edi-Sipka](https://github.com/edi-sipka)
- Twitter: [@sipka_edii](https://twitter.com/sipka_edii)
- LinkedIn: [Edi Sipka](https://www.linkedin.com/in/edi-%C5%A1ipka-5b681b202/)

(back to top)

## 🔭 Future Features

- [Edit and Delete Transactions] **[Delete or edit all transactions]**

(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 edit my transactions?]**

- [Currently you can only add transactions]

(back to top)

## 📝 License

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

(back to top)