evansnyamekye / budget-app

📗 Table of Contents

• 💰 Budget App
• 🛠 Built With
• Key Features
• 🚀 Live Demo
• Future Features
• 💻 Getting Started
• Setup
• Prerequisites
• Usage
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show Your Support
• 🙏 Acknowledgments
• 📜 License

💰 Budget App

This is a budget app that allows users to track their expenses and incomes. Users can create, edit, and delete transactions. The app also provides a summary of the user's transactions, including the total balance, total income, and total expenses.

🛠 Built With

• Ruby on Rails
• Ruby
• HTML
• CSS

Key Features

• User can create, edit, and delete transactions.
• User can view a summary of their transactions, including the total balance, total income, and total expenses.
• User can view a list of all their transactions, sorted by date.

(back to top)

🚀 Live Demo

• ✅ Click here to see the project
• ✅ Click here to see the video presentation.

(back to top)

🔭 Future Features

• User can view a summary of their transactions, including the total balance, total income, and total expenses.
• User can view a list of all their transactions, sorted by date.
• User can view a list of all their transactions, sorted by date.

💻 Getting Started

To get started with the Budget App, follow the instructions below:

🛠 Setup

1. Clone the project repository:

   git clone https://github.com/sadaf-Daneshgar/budget_app.git

2. Navigate to the project folder:

   cd budget_app

Prerequisites

Before you can run the Budget App, make sure you have the following prerequisites and configurations in place:

• Ruby: Ensure that Ruby is installed on your machine. You can check if it's installed by running ruby -v in your terminal. If it's not installed, you can download and install it from the official Ruby website.

• Ruby on Rails: You'll need the Ruby on Rails framework installed. If you don't have it yet, you can install it using the following command:

  gem install rails
  

• Code Editor: You should have a code editor like Visual Studio Code (VSCode) installed. You can download VSCode from the official website.

• Git: Git is essential for version control. Make sure you have Git installed and configured on your system. You can download Git from the official Git website.

• PostgreSQL: Ensure that PostgreSQL is installed and properly configured on the server where you are developing the project. This project assumes the use of PostgreSQL as the default database. You can download PostgreSQL from the official PostgreSQL website.

• Ruby on Rails Configuration: Make sure your Ruby on Rails project is configured to use PostgreSQL as the default database.

With these prerequisites and configurations in place, you'll be ready to set up and run the Blog App.

📖 Usage

Follow these steps to use the Blog App:

Open your terminal.

Navigate to the directory where the project files are located:

Copy code

cd /path/to/your/project/files

Start the Rails server:

Copy code

rails server

Open your web browser and go to http://localhost:3000 to access the Budget App.

👥 Authors

👤 Evans Kofi Nyamekye

• GitHub: evansnyamekye
• Twitter: @nyamekye2131
• LinkedIn: Evans Kofi Nyamekye

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page and contribute to the project.

⭐️ Show Your Support

If you like this project, kindly drop a start ⭐️ for the repository;

(back to top)

🙏 Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

• I would like to express my heartfelt gratitude to Microverse for the invaluable learning experience they have provided.

Original design idea by Gregoire Vella in Behance.

(back to top)

📜 License

This project is MIT licensed.

• Database creation

• Database initialization

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

• ...

budget-app's Issues

Issues & Contributions

Suggestions and Views are welcoming.