Skip to content

Latest commit

 

History

History
84 lines (46 loc) · 2.59 KB

README.md

File metadata and controls

84 lines (46 loc) · 2.59 KB
Raw

Budgit - A finance tracker app

A web application where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

image

Live demo: Budgit

Built With

  • Ruby
  • Ruby on Rails
  • Devise
  • PostgreSQL

Getting Started

To get a local copy up and running follow these simple example steps.

Pre-requisites

Make sure you have Ruby and Rails installed on your computer. If not, you can follow this tutorial to install them.

If you don't have PostgreSQL installed, you can follow this tutorial to install it.

If you don't have yarn installed, you can follow this tutorial to install it.

Usage

In your terminal, navigate to your current directory and run this code

git clone https://github.com/deyemiobaa/budgit.git

Then run

cd budgit

Open the project in your favorite code editor. code . for VS Code.

  • Use the command bundle install to install all project dependencies.
  • Run yarn install to install all the JavaScript dependencies.
  • Run yarn build:css to build the CSS files.
  • Run rails db:create db:migrate to create the database and run migrations.
  • You might need to supply a username and password for your PostgreSQL database if you run into an error with the previous step.
  • Simply navigate to config/database.yml and add your username and password to the username and password fields.
  • Type in the terminal rails s to start the server then click on http://127.0.0.1:3000
  • Start tracking your budget!

Testing

Within the projects working directory run test using the following command: rspec in the terminal

Author

👤 Sodiq

🤝 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

📝 License

This project is MIT licensed.