obibaadoma/expense-app

This is the capstone project of the fifth module in the Microverse program. It is a groceries budget app for managing grocery items for registered users built with Ruby on Rails & PostgreSQL.

Expense App

📗 Table of Contents

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

📖 About the Project

Expense App is an transaction tracker app containing data about transactions based on categories. A user can register/login and create transactions to track them.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Databases

• PostgreSQL

Key Features

• Contains data about categories
• Contains data about transactions

(back to top)

🚀 Live Demo

• Link to Live demo
• Quick Overview

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

• An IDE (ex: VS Code)
• Github account

Setup

Clone this repository to your desired folder:

  cd project-folder
  git clone https://github.com/obibaadoma/Expense-App.git

Install

Install this project with webpack:

  cd project-folder
  bundle install
  rails db:setup

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec spec

Deployment

You can deploy this project using GitPages:

• Go to github.com
• Create a new repository
• Add all website files in the new repository
• Go to Settings/Pages
• Go to branch and change from 'none' to 'main'
• Click Save

(back to top)

👥 Authors

👤 Derek Akrasi Konadu

• GitHub: Obiba-Kweku-Adoma
• Twitter: @ObibaKwekuAdoma
• LinkedIn: Derek Akrasi Konadu

(back to top)

🔭 Future Features

• More animations
• Calculator page

(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 and wish to collaborate. Please contact me.

(back to top)

🙏 Acknowledgments

• Original design idea by Gregoire Vella on Behance.

(back to top)

❓ FAQ

• Is it responsive?

  • Yes, works both on mobile and desktop.

(back to top)

📝 License

This project is MIT licensed..

(back to top)