Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/david-lanzz/budget-app

Last synced: 26 days ago
JSON representation

Host: GitHub
URL: https://github.com/david-lanzz/budget-app
Owner: David-Lanzz
Created: 2023-07-08T22:15:00.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-07-14T23:47:35.000Z (over 1 year ago)
Last Synced: 2023-07-15T00:29:14.542Z (over 1 year ago)
Size: 294 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Budget App ](#-Budget-app-)

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

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [👥 Authors ](#-authors-)

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

  - [🤝 Contributing ](#-contributing-)

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

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 Budget App 

Budget App is a web application that enables users to create, share, and explore Budgets and Transactions. Users can effortlessly create their own Budgets, including detailed category lists, transactions/entities while setting and also viewing of the prices of the entities are also made possible

## 🛠 Built With 

### Tech Stack 

  Project language 

  


    Ruby

  


  FrameWork

  


    ROR

  


  DataBase

  


    Postgres

  


### Live Demo

- **https://crib-zoil.onrender.com/**

### Loom Presentation

**https://www.loom.com/share/35e6a6ca63fc439fbaa792034e642ff4**

### Key Features 

- **log in**

- **Sign in**

- **A welcome page**

- **Display user and Categories**

- **Add Transaction**

(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 installed in your machine

- Ruby on Rails installed in your machine

- Postgres installed and all password and user being setup

- A code editor e.g Vs Code

- Any integrated terminal e.g powershell

### Setup

Clone this repository to your desired folder:

```

cd my-folder

git clone https://github.com/David-Lanzz/Budget-app.git

```

Don't forget to change UserName and Password with yours in [database.yml](./config/database.yml) file

### Install

Install this project with:

```

bundle install

```

### Usage

To run the project, execute the following command :

```

rails server

```

### Run tests

To run tests, run the following command:

```

rspec spec

rubocop . //=> for ruby file linting

npx stylelint "**/*.{css,scss}" //=> for CSS or SASS file linting

```

(back to top)


## 👥 Authors 

👤 **David-Lanzz**

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

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

- LinkedIn: [LinkedIn](https://linkedin.com/in/david-lanzz)

(back to top)


## 🔭 Future Features 

- [ ] **Better Styling of various webpages**

(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 give this repo a star and reach out on our social media, and we will be happy to know about it! 😃

(back to top)


## 🙏 Acknowledgments 

I would like to thank the Microverse team for assigning the tasks to me and also Gregoire Vella on Behance for providing the original design of this project 

(back to top)


## 📝 License 

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

(back to top)