https://github.com/ilyassatlassi/budget-app

https://github.com/ilyassatlassi/budget-app

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ilyassatlassi/budget-app
• Owner: ilyassatlassi
• License: mit
• Created: 2023-07-09T17:48:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-15T14:31:43.000Z (over 1 year ago)
• Last Synced: 2024-05-17T15:34:08.267Z (7 months ago)
• Language: Ruby
• Size: 95.7 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
Expensify App - Track your Expenses


# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

     - [🚀 Live Demo](#live-demo)

  - [📺 Presentation](#presentation)

  - [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 [Budget App] 

**[Budget App]** is based on Ruby Language and Rails framework.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
Ruby on Rails

  


  Server

  


    
Localhost

  


PostGre SQL

  


    
N/A

  


### Key Features 

- **[User Authentication]**

- **[Create Category for Payments]**

- **[Add Transactions to those Categories]**

(back to top)


## 🚀 Live Demo 

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

(back to top)


## 📺 Presentation 

- [Link to video presentation](https://www.loom.com/share/7bf8699cb3eb446cbfe88da085e4996b)

(back to top)


## 💻 Getting Started 

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

- clone this https://github.com/ilyassatlassi/Budget-app.git

### Prerequisites

In order to run this project you need:



    
Ruby and Ruby on Rails

    
- [Node.js](https://nodejs.dev/en/) installed

    
 - [PostgreSQL](https://www.postgresql.org/) database installed



  

  

### Setup


Clone this repository to your desired folder:



cd my-folder

git clone https://github.com/ilyassatlassi/Budget-app.git



### Install

Install this project with:



bundle install



### Usage

To run the project, execute the following command:



rails s



### Run tests

To run tests, run the following command: Install through : gem install rspec

Run: rspec to run tests

(back to top)


## 👥 Authors 

👤 **Ilyass Atlassi**

- GitHub: [@githubhandle](https://github.com/ilyassatlassi)

- Twitter: [@twitterhandle](https://twitter.com/ilyass_atlassi)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ilyassatlassi/)

(back to top)


## 🔭 Future Features 

- [ ] **[API and documentation will be added]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [repo](https://github.com/ilyassatlassi/Budget-app.git) 

(back to top)


## ⭐️ Show your support 

If you like this project please follow me on github

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse and and [Gregoire Vella](https://www.behance.net/gregoirevella) for design.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **[What is Budget App?]**

  - [Budget app is a web app that helps users categorize and manage their transactions for easy expense tracking. Stay organized and gain insights into your spending habits with this user-friendly tool.]

  - **Is Rails still relevant?**

  - [Yes, Rails is still popular among developer](https://blog.railwaymen.org/is-ruby-on-rails-dead)

(back to top)


## 📝 License 

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

(back to top)