An open API service indexing awesome lists of open source software.

https://github.com/progress2002/smartsaver

SmartSaver is a web-based budgeting application built using Ruby on Rails and PostgreSQL. With SmartSaver, users can effortlessly track their income and expenses, gaining full control over their finances. 💰💼
https://github.com/progress2002/smartsaver

css3 javascript postgresql ruby ruby-on-rails

Last synced: 3 months ago
JSON representation

SmartSaver is a web-based budgeting application built using Ruby on Rails and PostgreSQL. With SmartSaver, users can effortlessly track their income and expenses, gaining full control over their finances. 💰💼

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 TDD Project ](#-oop-school-library--)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [📽️ Video Presentation](#video)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Authors ](#authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

## 📖 SmartSaver
SmartSaver is a web-based budgeting application built using Ruby on Rails and PostgreSQL. With SmartSaver, users can effortlessly track their income and expenses, gaining full control over their finances. 💰💼

## 🛠 Built With

## Tech Stack

- [Ruby](https://www.ruby-lang.org/en/)
- [Ruby on Rails](https://rubyonrails.org/)
- [PostgreSQL](https://www.postgresql.org/)

## Key Features

- [ ] **Register an account**
- [ ] **Login registered account**
- [ ] **Create categories and transactions**

(back to top)

### 🚀 Live Demo

- [SmartSaver](https://smartsaver.onrender.com)

### 📽️ Video Presentation

[Video Presentation ] (https://www.loom.com/share/5d571397947b49f0a677c66a047801e0?sid=14c5b6cf-58cf-45bb-bf08-e4a63cb61bbb)-Powered by Loom

(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 to install the following on your machine:
- [Ruby](https://www.ruby-lang.org/en/)
- [Ruby on Rails](https://rubyonrails.org/)
- [PostgreSQL](https://www.postgresql.org/)

## Setup

Clone this repository to your desired folder:

Example commands:

- Clone this repository using GitBash or the command Terminal:

```sh
git clone https://github.com/Progress2002/SmartSaver.git

cd SmartSaver
```

## Install

- Inside the project directory, install the project's dependencies:

```sh
bundle install
```

- Create the app's database

```sh
rails db:create
```

- Setup the app's database

```sh
rails db:setup
```
## Usage

```sh
rails server
```
- Runs the app local server

## Authors

👤 **Progress**

- GitHub: [@Progress2002](https://github.com/Progress2002)
- Twitter: [@Progress_2002](https://twitter.com/Progress_2002)
- LinkedIn: [@Progress](https://www.linkedin.com/in/progress-ezeamaka-27b114247)
- Frontend Mentor - [@Progress2002](https://www.frontendmentor.io/profile/progress2002)

(back to top)

## 🔭 Future Features

- [ ] **[Delete and editit transactions]**
- [ ] **[Profile photo upload]**
- [ ] **[User profile seetings]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Progress2002/SmartSaver/issues).

(back to top)

## ⭐️ Show your support

If you like this project please leave a star. Thank you 🙏

(back to top)

## 🙏 Acknowledgments

- I would like to thank Microverse for the great project idea. ❤️
- Credit goes to [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) whose original design was used.

Icons were used from [Flaticon](https://www.flaticon.com/)

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)