Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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


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

Last synced: 14 days ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 Table of Contents

Click to view contents



  1. 📖 About the Project



  2. 💻 Getting Started


  3. 👥 Authors

  4. 🔭 Future Features

  5. 🤝 Contributing

  6. ⭐️ Show your support

  7. 🙏 Acknowledgements

  8. ❓ FAQ

  9. 📝 License

# 📖 Budget App

This **Budget App** is a ruby on rails application that allows users to create and update posts.

## 📹 Video



## 🛠 Built With

### Tech Stack

Client

Database

### Key Features

This projects aim is to help users implement a real-world project that

- where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

(back to top)

## 🚀 Live Demo
- [Video Demo Link](https://www.loom.com/share/ca59940837a04b618b95d787c663d174)

- [Live Demo Link]()

(back to top)

## 💻 Getting Started

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

### Prerequisites

- Ruby
- Rails
- Node package manager (npm)

### Setup

#### Github
- Enter this url: [https://github.com/stephnna/budget-app](https://github.com/stephnna/budget-app) in your web browser.
- Once opened navigate to the top left level of the project a green code download button will be visible on the righthand side.
- Select the download Zip option from drop-down menu.
- Once the download is complete you will be able to access my project locally.

#### Local (Terminal)

```sh
git clone [email protected]:stephnna/budget-app.git
cd budget-app
```

### Install

Install this project with:

### Usage

To run the project, execute the following command:

- Run `rails s` or `rails server` to start a development server.

### Run tests

To run tests, run the following command:

`rspec spec` will run all the tests.
Also, you can run `rspec spec/` to run specific tests.
You can also run `RAILS_ENV=test rspec spec/` to run the tests in test mode.

(back to top)

## 👥 Author

- GitHub: [@stephnna](https://github.com/stephnna)
- Twitter: [@stephnna](https://twitter.com/stephnna)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-ezea/)

(back to top)

## 🔭 Future Features

-allow user to manage budget

(back to top)

## 🤝 Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue, feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project. Don't forget to give it a ⭐️

(back to top)

## 🙏 Acknowledgments

- A big thanks to [@microverseinc](https://github.com/microverseinc) for the project idea, guidance and inspiration.
- [Find the original design here](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=)

(back to top)

## ❓ FAQ

- **What inspired me to create this project?**

- The inspiration for this project came from microverse – a software development bootcamp where you work with teammates remotely on different projects.

(back to top)

## 📝 License

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

(back to top)