Skip to content

Origami is a mobile web application to manage the budget. The logged-in user can see the money spent on each category and transaction. Build with Ruby on Rails and PostgreSQL.

Notifications You must be signed in to change notification settings

ElsonOtake/Origami

Repository files navigation

📗 Table of Contents

📖 Origami

Origami is a mobile web application to manage budget.

This application allows the customer to:

  • Register and log in, so that the data is private to them;
  • Introduce new transactions associated with a category;
  • See the money spent on each category.

🛠 Built With

Tech Stack

Client
Server
Database

Key Features

  • Authentication
  • Tests

(back to top)

🚀 Live Demo

(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

Setup

Clone this repository to your desired folder:

using HTTPS:

  git clone https://github.com/ElsonOtake/Origami.git
  cd Origami

using an SSH key:

  git clone git@github.com:ElsonOtake/Origami.git
  cd Origami

using GitHub CLI:

  git clone gh repo clone ElsonOtake/Origami
  cd Origami

Install

Set up Postgres credentials in .env file

POSTGRES_USERNAME=postgres_username
POSTGRES_PASSWORD=postgres_password

Install this project with:

  bundle install
  rails db:create db:migrate

Usage

To run the project, execute the following command:

  rails server

Open http://localhost:3000/ on your browser.

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Author

👤 Elson Otake

(back to top)

🔭 Future Features

  • CRUD for Categories and Transactions
  • Transaction details 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

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

(back to top)

📝 License

This project is MIT licensed.

(back to top)

About

Origami is a mobile web application to manage the budget. The logged-in user can see the money spent on each category and transaction. Build with Ruby on Rails and PostgreSQL.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published