ck3g / homebugh Goto Github PK

The expense tracking app.

• iOS app
• API

HomeBugh app is a web application to track your home finance expenses.

There are a bunch of articles and books describing the benefit of tracking expenses. So that's exactly what we do with my family. We track all our expenses.

There are plenty of ways to track your expenses, you can use an Excel spreadsheet, third-party applications. I've decided to build a tool for myself. That's how the project was born.

It has (almost) all required pieces of functionality I need. And I work on some improvements from time to time.

Yet another goal of that project is to practice software development. I've started it when I started to learn Ruby and Ruby on Rails.

It helped me to experiment with different code practices, implement the features I needed in the way I wanted and knew.

There are still some parts I'd like to implement. I'm thinking to build a mobile application, that will require providing an API.

Another idea is to make the project available for everyone. At the moment, I think I'm the only user of that application which is hosted on HomeBugh.info.

I understand some people don't want to share their personal finances with some service. Based on that, I'd like to provide instructions for others to set up the project on their own hosting service.

I'm planning to add a demo user to the project, so everyone can take a look at the project without the need to register.

If the project gets more users, that should bring new ideas on improvements in different areas of the project. So, if you want to practice web development that project can be a good place for you.

Be sure there are required dependencies installed on your computer:

• Ruby version 2.7
• MySQL

1. Fork and clone the repo $ git clone [email protected]:ck3g/homebugh.git
2. $ cd homebugh
3. Copy and update the database config according to your local MySQL configuration

   $ cp config/database.yml.example config/database.yml

4. Install all the required gems

   $ bundle

5. Migrate the database:

   $ bundle exec rails db:environment:set RAILS_ENV=development
   $ bundle exec rails db:create db:schema:load db:migrate db:test:prepare

6. Seed the database with required data

   $ bundle exec rails db:seed

7. Run the test suite to ensure everything is in working state

   bundle exec rspec spec/

8. Start the Rails server

   bundle exec rails s

9. Open http://localhost:3000 in your browser
10. Use [email protected] with the password to sign in.

Would you like to deploy the app to Heroku? Check out our experimental guide.

Any contributions to the project are always welcome. Please check out the Contributing guide.

HomeBugh app is released under the MIT License.