Skip to content

Latest commit

 

History

History
80 lines (47 loc) · 2.2 KB

README.md

File metadata and controls

80 lines (47 loc) · 2.2 KB

Project Name Budget App (Snack Time)

Description the project. The Budget App records all the purchases made against different categories and sections in the consumer market. It helps to record and manage different items and their relevant expenses and details of those expense. This is the perfect ROR capstone project.

Live App Link https://ror-budget-capstone.herokuapp.com/users/sign_in

Built With Languages: Ruby Frameworks: Ruby On Rails Technologies used: Visual Studio Code Requirements In order to work on this project, you need to have the following dependencies installed:

Ruby Postgresql Node.js Yarn Rails

Getting Started Clone this repository $ git clone https://github.com/AsimKhan2019/Budget-App.git $ 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.

Important note: Since this project uses TailwindCSS for the styling, you need to run:

$ ./bin/dev

For you to see the styling being applied in the browser during development

Authors

👤 Asim Mehmood Khan

🤝 Contributing Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support Give a ⭐️ if you like this project!

Acknowledgments Victor Peralta Gomez - A Microverse Legend and an Awesome Coder Ahmet - Technical Learning Assistance and a nice gentleman

📝 License This project is MIT licensed.