https://github.com/ackonsamuel/budget-app
This is a A rails application that allows users to create expense categories and track the transactions per category. A transaction can belong to multiple categories. It includes user authentication and data is preserved using postgresql.
https://github.com/ackonsamuel/budget-app
postgresql ruby ruby-on-rails
Last synced: 2 months ago
JSON representation
This is a A rails application that allows users to create expense categories and track the transactions per category. A transaction can belong to multiple categories. It includes user authentication and data is preserved using postgresql.
- Host: GitHub
- URL: https://github.com/ackonsamuel/budget-app
- Owner: AckonSamuel
- Created: 2022-11-15T10:18:42.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-11-25T14:20:23.000Z (over 3 years ago)
- Last Synced: 2025-04-12T10:16:38.924Z (about 1 year ago)
- Topics: postgresql, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 173 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Budget App
> This is a A rails application that allows users to create expense categories and track the transactions per category. A transaction can belong to multiple categories. It includes user authentication and data is preserved using postgresql.
## Built With
- Ruby on Rails
- postgresql
## Live demo
[Live link](https://moneywatcher.fly.dev/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Ruby runtime environment
- Postgresql
- Rails
### Setup
- Clone the repository using `git clone git@github.com:AckonSamuel/budget-app.git`
- Navigate to the folder using `cd budget-app`
### Commands to run
Run
```
$ bundle install
```
To get all the gems required for the project
Then, run
```
$ npm install
```
To install packages such as style linters
To check linters locally, use
```
$ rubocop
$ npx stylelint "**/*.{css,scss}"
```
Once you have the project correctly set up, run
```
$ bin/rails db:setup
```
To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes
Finally, each time you make changes to the project, run
```
$ bundle exec rspec /spec
```
In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description.
For you to see the styling being applied in the browser during development
## Authors
👤 **Ackon Samuel**
- GitHub: [@AckonSamuel](https://github.com/AckonSamuel)
- LinkedIn: [Ackon Samuel](https://www.linkedin.com/in/samuel-yaw-ackon/)
- Twitter: [@dude_ackon](https://twitter.com/dude_ackon)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
-Original design idea by [Gregoire Vella](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=) on Behance.
- Hat tip to anyone whose code was used
- Inspiration
- etc
## 📝 License
This project is [MIT](https://github.com/XsidX/budget_app/blob/dev/MIT.md) licensed.
NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._