bernabasy/Budget-app

Budget-app is for expense tracking and budget management. User-friendly interface, real-time updates, and secure authentication. Built with Rails.

📗 Table of Contents

• 📗 Table of Contents
• 📖 Transaction Buddy
  • 🛠 Built With
    • Tech Stack
    • Live Link
    • Loom Video
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Run tests
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Budget-app

Budget-app is an application that One can create categories for all their transaction, view total cost of all categories, view the cost of one transaction.

🛠 Built With

Tech Stack

Client

• HTML
• CSS

Server

• Ruby on Rails

database

• Postgresql

Live Link

The hosted app can be found here

(back to top)

Loom Video

The loom video can be found here

(back to top)

Key Features

• Login
• Signup
• Create category
• Create transaction

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps:

To get a local copy up and running, follow these steps:

• Create a local directory where you can clone the project
• Clone the project to your directory by running
  • https://github.com/bernabasy/Budget-app.git
• Run Bundle install
• Run npm install
• Create a .env file and add values for POSTGRES_USERNAME and POSTGRES_PASSWORD
• Run rails rails db:create db:migrate`
• Run rails rails db:migrate`
• Run rails s

Prerequisites

To run the app you need:

• A code editor
• A browser
• Install Nodejs
• Install Ruby
• Install Rails

Setup

Clone this repository to your desired folder:

• Create a local directory where you can clone the project
• Clone the project to your directory by running
  • git clone https://github.com/bernabasy/Budget-app.git

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Author

👤 Bernabas

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Improve UI
• Add funcionality

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project kindly leave a ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the great resources shared. I would also like to thank Gregoire Vella for the wonderful design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)