📗 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

📖 Xpens App

This is an app that allows users to track their budget by keeping track of their transactions based on different catagories specified by the user.

• You can find a video description of my project here

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User authentication when login
• Allows users to create any category of their choice.
• Tracks the transactions made with in each category.

(back to top)

🚀 Live Demo

• Live Demo Link

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

• Ruby installed in your machine, you can user this link to install in your OS.
• PostgreSQL is installed in your machine, you can refer this link to install in your machine. Then run:

Setup

Clone this repository to your desired folder:

  git clone https://github.com/SekoViper/bud.git

  cd budget-app

  bundle install

Usage

To run the project, execute the following command:

  rails db:create db:migrate

  rails server 

• NOTE: In the development.rb file, make sure to provide a working email to the user_name section and password generated from your email provider to have the project working, or you can follow this steps to skip the validation:

1. Remove or comment the :confirmable from the User.rb devise options.
2. Comment line[76 - 86] from the development.rb, which is handling the email comfirmation.
3. Start your server and try again.

Run tests

To run tests, run the following command:

  rspec --format documentation

Deployment

• You can deploy this project on render using this link

(back to top)

👥 Author

• GitHub: @SekoViper
• LinkedIn: Livingstone Dameh

(back to top)

🔭 Future Features

• Allow user to edit their profile.
• Allow user to edit a group/ category.
• Add income registering feature.
• Add algorithm to take income, cost and user saving goal and give suggestion.

(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 make sure to leave a like. Thanks in advance 🙏

(back to top)

🙏 Acknowledgments

I would like to thank Gregoire Vella on Behance and Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)