Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pamphilemkp/expenses-tracker-app

It is basically a mobile web application where you can manage your budget: you have a list of transactions associated with a certain category, so that you can see how much money you spent and on what.
https://github.com/pamphilemkp/expenses-tracker-app

postgresql rails ruby

Last synced: 28 days ago
JSON representation

It is basically a mobile web application where you can manage your budget: you have a list of transactions associated with a certain category, so that you can see how much money you spent and on what.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [🚀 Live Demo](#live-demo)
- [Live video](#live-video)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Author](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 EXPENSES TRACKER APP

> Expenses-tracker-app is an application that allows the user to:

> - register and log in, so that the data is private to them.
> - introduce new transactions associated with a category.
> - see the money spent on each category.

It is basically a mobile web application where you can manage your budget:
you have a list of transactions associated with a certain category,
so that you can see how much money you spent and on what.

**
expenses-tracker-app** is a Ruby on Rails application...

## 🛠 Built With

### Tech Stack

Client / Server

Deploy

Database

Tests

## 🚀 Live Demo

- [Live Demo Link]()

(back to top)

## 🚀 Live video

- [Live video](https://www.loom.com/share/6bc6987da8264d86bdeea284531ed8bb)

(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:

- You should have ruby installed in your machine, you can follow the steps given by the [official documentation](https://www.ruby-lang.org/en/documentation/installation/).

- You should have a postgres user with superuser permissions. you can refer to the official [postgres documentation](https://www.postgresql.org/docs/current/role-attributes.html#:~:text=To%20create%20a%20new%20database,that%20is%20already%20a%20superuser.&text=A%20role%20must%20be%20explicitly,use%20CREATE%20ROLE%20name%20CREATEDB%20.) to create or update a role.

### Setup

First, you must clone this repository locally running this command:

```
git clone [email protected]:pamphilemkp/expenses-tracker-app.git
```

and navigate to the cloned directory:

```
cd expenses-tracker-app
```
### Install

Once inside the project directory, you should install all project dependencies:

- Install bundler:

```
gem install bundler
```

- Install project dependencies

```
bundle install
```

### Usage

You can get the app running locally by opening a local server:

```
bin/rails server
```

### Run tests

If you're on a linux-based system, you could run the executable file to run all specs:

```
bin/rspec
```

Windows users have to specify ruby in this case:

```
ruby bin/rspec
```

## 👥 Author

👤 **Pamphile Mkp**

- GitHub: [@pamphilemkp](https://github.com/pamphilemkp)
- Twitter: [@pamphilemkp](https://Twitter.com/PamphileMusonda)
- LinkedIn: [@pamphilemkp](https://www.linkedin.com/in/pamphile-musonda)

(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

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

- Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella). Published under the [Creative Commons license](https://creativecommons.org/licenses/by-nc/4.0/).
- Linters workflow created by [@anagudelogu](https://github.com/anagudelogu)

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)