Kelvin-Ben / Payment-App

An application that monitor your spending to make sure that every payment is noted to reduce over spending

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Payment App

Payment App is a mobile web application 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 have spent and on what

🛠 Built With

Tech Stack

Client

• Ruby

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Here the main goal of building this web application is to have a deeper understanding of how Ruby on Rails can make development of applications easy

• [Create associations between different models involved]
• [Use migration files]
• [Build a schema from models]

(back to top)

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

• linters.yml and tests.yml files inside the .github folder
• .rubocop.yml file
• Gemfile
• Install rails and required gems

Setup

Clone this repository to your desired folder:

1- Navigate to the button on the top right green "code" button.

2- In the drop down menu choose "Download Zip" or clone it using git using the following command.

3- After extracting the files, you'll have my project on your local machine.

Install

Install this project with:

• Run bundle install

Usage

To run the project, execute the following command:

[$ ruby FILENAME.rb]

Run tests

To run tests, run the following command:

Example command:

  bin/rails test test/models/article_test.rb

(back to top)

👥 Authors

👤 Kelvin Benjamin

• GitHub: @Kelvin-Ben
• Twitter: @kevoyout144
• LinkedIn: Kelvin-Ben

(back to top)

🔭 Future Features

I will create a Ruby on Rails application that allows the user to:

• Register and login, so that the data is private to them
• Introduce new transactions associated with a category
• See the money spent on each category

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Anyone who finds this project interesting is welcome to give it a star.

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for the opportunity
• Also, original design idea by Gregoire Vella on Behance

(back to top)

❓ FAQ (OPTIONAL)

• How do i run the project in my local machine?

  • You need to clone the project in your local environment through the terminal

• What database are you using for this project?

  • [POSTGRESQL]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)