📗 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
• 📝 License

📖 [Spend Right Budget App]

Spend Right is a full stack ruby on rails web application on a postgreSQL database that is built to manage your finances by grouping your expenses or transactions into categories and helping you visualize how much your are spending and where you are spending the most amount of money.

🛠 Built With Ruby on Rails

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• HTML
• CSS

Server

• Render

Database

• PostgreSQL

Key Features

• Spash screen to intoduce user to app
• Total amount of transactions in each category
• Ability to add new category
• Ability to add new transaction to a 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:

• Install Ruby
• Install node
• Install npm
• A code editior
• A web browser (Chrome, preferrably)

Setup

Clone this repository to your desired folder:

  cd [my-folder]
  git clone [email protected]:amon-cofie/spend-right-budget-app.git
  cd spend-right-budget-app

Install

Install this project with:

  bundle install
  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Run tests

Tests are written with RSpec

To run tests, run the following command:

  rspec spec

Deployment

You can deploy this project using:

  render

(back to top)

👥 Author

👤 David Amon-Cofie

• GitHub: @amon-cofie
• Twitter: @amon_cofie
• LinkedIn: David Amon-Cofie

(back to top)

🔭 Future Features

• View details of each transaction
• Futher organize the transactions by time created
• Add statistics with graphs and charts

(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, a star would be much appreciated

(back to top)

🙏 Acknowledgments

Original design idea by Gregoire Vella on Behance

I would like to thank everyone who gave me inspiration and insight into the look and feel of this project

(back to top)

📝 License

This project is MIT licensed.

(back to top)