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

https://github.com/developerwaleed/budget-manager

Looking to stay on top of your budget? Budget Manager is here to help. This mobile web application lets you create categories and add transactions to keep your finances in order.
https://github.com/developerwaleed/budget-manager

postrgesql rails ruby

Last synced: about 1 year ago
JSON representation

Looking to stay on top of your budget? Budget Manager is here to help. This mobile web application lets you create categories and add transactions to keep your finances in order.

Awesome Lists containing this project

README

          


logo


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Budget Manager ](#-budget-manager-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Budget Manager

Looking to stay on top of your budget? **Budget Manager** is here to help. This mobile web application lets you create categories and add transactions to keep your finances in order.

## 🛠 Built With

### Tech Stack

Server

Database

### Key Features
- **User Authentication with devise**
- Bootstrap5 has been used for styling!

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://budget-manager.onrender.com/)

(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 runtime environment
- Postgresql
- Rails

### Setup

Clone this repository to your desired folder:

### Install

Install this project with:

- Clone the repository using `https://github.com/developerwaleed/Budget-Manager.git`
- Navigate to the folder using `cd Budget-Manager`
- Use the following commands to
- install necessary gems `bundle install`
- create database `rails db:create`
- run migrations and create default user as admin `rails db:migrate db:seed`

### Usage

To run the project, execute the following command:

```sh
rails s
```

### Run tests

To run tests, run the following command:

```sh
rspec spec
```

### Deployment

You can deploy this project using:
- Heroku

(back to top)

## 👥 Authors

| 👤 Name | Github | Twitter | LinkedIn |
|------|--------|---------|----------|
|Waleed Amjad|[@developerwaleed](https://github.com/developerwaleed)|[@developerwaleed](https://twitter.com/developerwaleed)|[@developerwaleed](https://www.linkedin.com/in/developerwaleed/)|

## 🔭 Future Features

- Allow users to add their avatar.
- Create API endpoints to allow users to update their info.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project...

(back to top)

## 🙏 Acknowledgments

We would like to thank microverse for providing the curriculum to guide us on this project.

(back to top)

## 📝 License

This project is [MIT](https://github.com/developerwaleed/final-capstone-back-end/blob/fixes/MIT.md) licensed.

(back to top)