Recipes App

📗 Table of Contents

• 📗 Table of Contents
• 📖 SmartSpendr
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Deployment
  • 💻 Getting Started
    • Prerequisites
    • Install & Setup
    • Tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 SmartSpendr

SmartSpendr is a web application crafted with Ruby on Rails and powered by PostgreSQL. This App is designed to help you spend smarter, and budget better! It helps you to track you expenditures across the different categories they fall into, to help you see where all you money is "disappearing" to!

🛠 Built With

Tech Stack

Client

• Ruby on rails

Database

• PostgreSQL

Styling

• CSS3

Key Features

• Login and Sign Up features implemented using Devise
• Allows users to record and create new Categories and Transactions
• Breaks down spending for better analysis

(back to top)

🚀 Deployment

• Video Presentation

• Demo link

💻 Getting Started

To start and run this project

bundle install

rails s

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

Prerequisites

In order to run this project you need:

    ruby >= 3.2.0
    rails >= 7.0
    postgres >- 15.3

As well as:

• IDE to edit and run codes.
• Git.
• PostgreSQL installed

Install & Setup

To setup and install this project, follow the below steps:

• Clone this project by the command:

$ git clone git@github.com:sunga12/Smartspendr.git

• Then switch to the project folder:

$ cd Smartspendr

• Install the required dependencies with bundle install
• Install npm dependencies with npm install
• Run rails db:setup
• Run rails db:migrate
• With Ruby on Rails and PostgreSQL installed in your environment, you can run rails server, rails s or ./bin/dev to run the website.

Tests

• Run rails db:seed RAILS_ENV=test to seed the testing database
• Run rspec

(back to top)

👥 Authors

👤 Sungabanja Thawethe

• GitHub: @Sunga12
• LinkedIn: Sungabanja Thawethe

(back to top)

🔭 Future Features

• Graph based Analysis and Tracking
• Add more styling to improve the UI
• Desktop Version
• Side menu Functionality

(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 star!

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for providing the project specifications as well as the lessons leading up to the project that made completing it possible.

• I would also like to thank Gregoire Vella for the Original design idea on Behance

(back to top)

📝 License

This project is MIT licensed.

(back to top)