Rails Recipe

📗 Table of Contents

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

📖 MoneyMate

MoneyMate is a personal finance tracking application that allows the user to track their spending by recording transactions under user-defined categories. This functionality gives the user a good overview of their spending habits, and allows them to quickly notice areas that need improvement.

🛠 Built With

Tech Stack

Client

• HTML
• ERB
• CSS

-

Server

• Ruby on Rails
• PostgreSQL

Key Features

• ORM model
• Intuitive design
• A selection of Icons for the categories

(back to top)

🚀 Live Demo

• Live Demo Link
• Video Presentation

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

• A text editor of your choice (VS Code works well).
• Ruby and Rails
• Git

Setup

Clone this repository to your desired folder with the following command:

[email protected]:badger-99/money_mate.git

Install

Open the terminal in the root directory of the project and run the folloeing command to install all dependencies.

bundle install

Usage

To start the development server, run the following command then navigate to localhost:3000 in your browser.

bin/rails server

Run tests

Run the following command to execute the tests:

rspec 

(back to top)

👥 Authors

👤 Alfred M.

• GitHub: @badger-99
• X: @AlfredMkg
• LinkedIn: in/alfredmkg

(back to top)

🔭 Future Features

• More Icons
• API endpoints

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please give it a star ⭐️ and share it with your friends.

(back to top)

🙏 Acknowledgments

I would like to thank Gregoire Vella for making the design that this app is based on freely available through the Creative Commons license, and I would also like to thank Microverse for providing the resources and guidelines that enabled me to complete this project.

(back to top)

📝 License

This project is MIT licensed.