📗 Table of Contents

• 📗 Table of Contents
• 📖 ExpenseApp
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • Preview
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements

• 📝 License

📖 ExpenseApp

Expense App is an expenses management app created using Ruby on Rails. It allows a user to create new categories and create new expenses for each category thus you have a list of transactions associated with a category.

🛠 Built With

Tech Stack

• Rails
• PostgreSQL
• Tailwind CSS
• JavaScript

Key Features

• User Registration.
• User login.
• Create Category: a user can create a category for his expenses.
• Create transaction(expense): a user can create a transaction that belongs to a specific category.

Preview

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• IDE or code editor: VsCode, atom, sublime...
• To have Ruby and Git installed on your system.
• To have Node.js installed on your system.

After installing Ruby, run the following command to install rails.-

 gem install rails

Setup

Clone this project on your local machine using the following command in your terminal:

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

Install

Run the following command to install all project's dependencies:

  cd Budget-app
  bundle install
  node install

Usage

To run the project, execute the following command:

Example command:

  rails server

OR

  rails s

Run tests

To run tests, run the following command:

Example command:

  gem install rails rspec
  rspec ./spec/models/

👥 Author

👤 Gina Beki

• GitHub: @ginabeki
• Twitter: @gina
• LinkedIn: @ginabeki

🔭 Future Features

• Deploy the project and make it available for every one.
• Advance the UI

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project, kindly give it a star ⭐️

🙏 Acknowledgments

• Microverse😉
• Ruby on Rails Documentation🙃
• Huge appreciation to Gregoire Vella for providing design system guidelines🙃

📝 License

This project is MIT licensed.

(back to top)