Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/newhoteng/extrack

Extrack is an expense tracking app. It allows users to make transactions associated with one or more categories and view total transactions for each category.
https://github.com/newhoteng/extrack

css3 devise rspec-rails ruby-on-rails

Last synced: 14 days ago
JSON representation

Extrack is an expense tracking app. It allows users to make transactions associated with one or more categories and view total transactions for each category.

Awesome Lists containing this project

README

        

# 📗 *Table of Contents*

- [📖 About the Project](#about-project)
- [🛠️ 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)
- [Database](#database)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# :open_book: ExTrack
Extrack is an expense tracking app that allows user to create new transactions associated with a category and see the money spent on each category.

- [Video Presentation](https://www.loom.com/share/e9b41d8a2eaa43239da64e00eac1bd58?sid=b2932f6a-2713-4795-8e71-7db0eac7a6b4)

## :hammer_and_wrench: Built With
### Tech Stack
Client

Backend

Database

### Key Features
- Record a transaction
- Associate a transaction with a category
- Create new categories
- View amount spent on each category

(back to top)

## :rocket: Live Demo
- [Live Demo](https://extrack.onrender.com)

(back to top)

## :computer: Getting Started
To get a local copy up and running, follow these steps.

### Prerequisites

You need the following tools be installed in your computer:

- [Rails](https://guides.rubyonrails.org/)
- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
- [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
- IDE

### Setup

Clone this repository to your desired folder:

```sh
cd my-prefered-folder

git clone https://github.com/newhoteng/ExTrack.git
```

### Install

Install this project with:

```sh
cd Extrack

bundle install
```

### Database

Create the databases and run migrations with:

```sh
rails db:create
rails db:migrate
```

### Usage

To run the project, execute the following command:

```sh
rails server or rails s
```

### Run tests

To run tests, run the following command:

```sh
rspec spec/
```

(back to top)

## :busts_in_silhouette: Authors
:bust_in_silhouette: **Harriet Oteng**
- GitHub: [@githubhandle](https://github.com/newhoteng)
- Twitter: [@twitterhandle](https://twitter.com/HarrietOteng1)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/harriet-oteng-75554666/)

(back to top)

## :telescope: Future Features
- Record income
- Add more category options
- View monthly savings
- Improve styling

(back to top)

## :handshake: Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/newhoteng/ExTrack/issues).

(back to top)

## :star: Show your support
If you like this project give it a star.

(back to top)

## :pray: Acknowledgements
- Thanks to Gregoire Vella for the UI/UX design.
- Thanks to my coding partners for their support

(back to top)



## :memo: License

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

(back to top)