https://github.com/eduardosancho/budget
Mobile app to organize spending and group transactions into categories.
https://github.com/eduardosancho/budget
budget database ruby
Last synced: about 1 month ago
JSON representation
Mobile app to organize spending and group transactions into categories.
- Host: GitHub
- URL: https://github.com/eduardosancho/budget
- Owner: eduardosancho
- Created: 2022-05-23T23:58:37.000Z (about 4 years ago)
- Default Branch: development
- Last Pushed: 2022-05-30T18:34:58.000Z (about 4 years ago)
- Last Synced: 2025-02-26T11:44:42.954Z (over 1 year ago)
- Topics: budget, database, ruby
- Language: Ruby
- Homepage: https://rocky-cliffs-67926.herokuapp.com/
- Size: 42.9 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Budget App
[](./MIT.md)
[Live Demo](https://rocky-cliffs-67926.herokuapp.com/)
# Preview
# Table of Contents
- [Description](#description)
- [Built With](#built-with)
- [Setup](#setup)
- [Clone Repo](#clone-repo)
- [Prerequisites](#prerequisites)
- [Install Rails](#install-rails)
- [Getting Started](#getting-started)
- [System Dependencies](#system-dependencies)
- [Database Initialization](#database-initialization)
- [Usage](#usage)
- [Start Server](#start-server)
- [Testing RSpec](#testing-rspec)
- [How To Contribute?](#how-to-contribute)
- [Collaborators](#collaborators)
- [Show Your Support](#how-your-support)
- [Acknowledgments](#acknowledgments)
- [License](#license)
## Description
> Mobile application that allows users to organize their finances by recording transactions and assigning them categories.
## Built With
- Major languages: Ruby, HTML, Bootstrap 5.
- Frameworks: Ruby on Rails.
- Tools & Methods: AWS, ActiveStorage, RSpec, PostgreSQL, Devise.
# Setup
We'll need to prepare your computer to handle Ruby on Rails, which might be a hassle, so take a deep breath and cope with me :)
If you have Rails 7 installed, you can skip to the [Getting Started](#getting-started) section
## Clone Repo
First clone this repo by running this command in your terminal:
~~~ bash
git clone https://github.com/eduardosancho/budget.git
# wait a couple seconds for it to download
# ...
# ...
# then move into the new directory
cd budget
~~~
## Prerequisites
The following technologies must be installed before hand in your local machine:
- Ruby (ruby --version). Should be 3.0.1 or newer.
- SQLite3 (sqlite3 --version)
- Node.js (node --version)
- Yarn (yarn --version)
The commands in parenthesis `()` can be used to verify if they are installed and their corresponding versions.
Refer to [Section 3](https://guides.rubyonrails.org/v5.1/getting_started.html#:~:text=3%20Creating%20a%20New%20Rails%20Project) from the official [Rails Guide](https://rubyonrails.org/) for more detailed instructions on how to install these technologies.
### Install Rails
Once that's done, we can install Rails. For that, run these commands in your terminal:
~~~ bash
gem install rails
# wait a few seconds for it to download
# ...
# ...
# verify that it was installed by running
rails --version
~~~
# Getting Started
The next steps setup the playing field for you to run the app in your local machine.
## System Dependencies
We're getting there... trust me ;)
Execute this command to automatically install all the dependencies needed to view and work on this project:
~~~ bash
bundle install
~~~
The full list of dependencies can be found within the [Gemfile](Gemfile).
This also installs PostgreSQL, which you'll need for the next step.
## Database Initialization
The following command will create the database and populate it with default data:
~~~ bash
rails db:setup
~~~
The databases will be called `budget_development` and `budget_test`, you can access them manually via the command `rails db`.
## Usage
If you got to this point, congratulations! You now have spent 2 hours in order to toy with my app. I appreciate your effort :P
## Start Server
The following command should start a server
~~~ bash
rails server
#or
./bin/dev
~~~
Which you can visit by going to http://localhost:3000 in your browser.
## Testing RSpec
RSpec tests belong in another folder, which is [/spec](/spec/), all thanks to the ruby **magic** called `naming conventions`.
Anyway, to run tests located in the spec folder run:
~~~ bash
bundle exec rspec spec
~~~
## How To Contribute?
Always remember to commit your contributions on a different branch. You can create a new one by running `git checkout -b `.
Visit [linters folder](.github/workflows/linters.yml) to learn how to setup linters.
Then check linters locally before pushing by running:
~~~ bash
npx stylelint "**/*.{css,scss}" --fix
# ...
# ...
bundle exec rubocop -A
~~~
Finally, once your changes have no linter errors and all [tests](#testing-rails) are passing, try to merge your branch into `development` by running:
~~~ bash
git checkout development
git merge
~~~
Continue by solving any merge conflicts that may arise, test the functionality of the app once more, and you're changes are ready to be pushed with `git push origin `
# That's all folks!
## Collaborators
👤 **Eduardo**
Platform | Badge |
--- | --- |
**GitHub** | [@eduardosancho](https://github.com/eduardosancho)
**Twitter** | [@sanchitoblog](https://twitter.com/sanchitoblog)
**LinkedIn** | [Eduardo Sancho Solano](https://www.linkedin.com/in/eduardo-sancho-solano/)
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
The ideas and inspiration from this project are coming from this online school of software development:
[**Microverse**](https://www.microverse.org/)
The design of this app belongs to [**@gregoirevella**](https://www.behance.net/gregoirevella), you can find it on [**Behance**](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=).
## 📝 License
This project is [MIT](./MIT.md) licensed.