nejjari001/budget-app

BUDGET APP README

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 BUDGET APP

Budget App allows you to create cateories, and transactions based on these categories there by helping you to keep track of your transactions based on the categories. The application will enable you to add a photo or icon to a category, there by helping you to distinguish between them. The category consists of all the transaction details including the amount for each transaction and the total sum of transactions per category.

🛠 Built With

Tech Stack

Client

• Ruby

Server

• Rails Default Server

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• Create a category for your transactions
• Add a transaction based on a preffered category
• Display the details of all transactions in a particular category

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby and rails installed
• PostgreSQL server installed
• Visual Studio Code

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Nejjari001/budget-app

Install

Install this project with:

  cd budget-app

Install the required gems

  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  gem install rspec
  rspec spec

Deployment

You can deploy this project using render

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 NEJJARI ABDELHAFID

• GitHub: @Nejjari001
• Twitter: @AbdoNJ19
• LinkedIn: Abdelhafid Nejjari

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• A desktop interface
• Add more functionality and authorization

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project, please give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for their continued support. They've provided us with the reading material that have helped us to create this application.

I would also like to give a special shout out to Gregoire Vella on Behance for the amazing design template.

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

• Can I reuse this code?

  • Yes sure, feel free.

• Are contributions welcome?

  • Yes please. Contact me at [email protected] and I will be happy to add you as a contributor.

(back to top)

📝 License

This project is MIT licensed.

(back to top)