rbanos-mv / xpenses

XpenseS 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 spent and on what.

XpensES

XpenseS 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 spent and on what..

Live demo

• Visit: https://xpenses.onrender.com/
  • Sign up to create your user and password before you can use the app.

Recorded video

• Click on this link to watch a demo recorded in video.

Built With

• Ruby on Rails
• PostgreSQL
• devise - for authentication
• cancancan - for authorization

Getting Started

To get a local copy up and running follow these simple steps:

Prerequisites

• Ruby ruby-3.1.2 installed
• PostgreSQL dbms running

Setup

• Open your terminal and navigate to the folder you would like to save the project.

• Type these commands into the terminal:

git clone https://github.com/rbanos-mv/xpenses.git
cd xpenses
bundle install

• You will need a .env file before you install and run the project. The .env file contains environment variables needed to deploy the webpage. There is a commented .env.example file you can use as a guide to configure your own. Type the following commands into the terminal (or Git Bash, if using Windows) to create your .env file:

cp .env.example .env

rails secret

• Edit file .env

  • Provide the values for the variables
    • DATABASE_HOST
    • DATABASE_USER
    • DATABASE_PASSWORD

• Type this commands into the terminal:

rails db:reset

Run application

• Type this command into the terminal:

rails server

• Open your web browser at http://127.0.0.1:3000/

Testing

• Type this command into the terminal:

rspec

Authors

👤 Roberto A. Baños Alvarez

• GitHub: @rbanos-mv
• Twitter: @RobertoBanosMV
• LinkedIn: Roberto A Baños Alvarez

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse for the motivation.
• Original design idea by Gregoire Vella on Behance
• Logo by Iraida Elisa Baños Zúñiga

📝 License

This project is MIT licensed.