README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Available Scripts
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

rails-budget-app

rails-budget-app is a web mobile friendly app that supports user registration and authentication using the Devise gem, a user can create his own account on the app and after logging in she/he will be able to add categories and then add transactions under those categories, the app provide some metrics like the total value of transactions under each category, the app was build using Ruby on Rails framework.

Built With

Tech Stack

• Ruby 3.1
• Ruby on Rails 7
• PostgreSQL 15

Key Features

• Register an account
• Create categories and transactions
• Metrics about user transactions

Live Demo

• Live Demo Link

Getting Started

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

Prerequisites

• Ruby
• Ruby on Rails
• PostgreSQL
• any code editor

Setup

To setup the project follow the steps:

1. Clone this project using Git Bash:

   git clone https://github.com/Daphineatim/rails-budget-app.git
   

2. Inside the project directory, install the project's dependencies

   bundle install
   

3. Create the app's database

   rails db:create
   

4. Setup the app's database

   rails db:setup
   

Available Scripts

In the project directory, you can run:

• rails server
  

  Runs the app local server

• bundle exec rspec
  

  Launches the test runner.

Author

👤 Daphine Atim

• GitHub: @Daphineatim
• Twitter: @dhaphyn
• LinkedIn: DaphineAtim

Future Feature

• Create a user profile
• Create a desktop version

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project give it a star!

Acknowledgments

• Microverse ❤️

• Credit goes to Gregoire Vella on Behance whose original design was used.

License

This project is MIT licensed.