📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run with Docker
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 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

• Ruby on Rails

Server

• Devise
• JWT
• Cancancan
• Bullet
• RSpec Rails
• Factory Bot
• Bulma
• Font Awesome
• Friendly Id

Database

• PostgreSQL

DevOps & Deployment

• Docker

Key Features

• Authentication
• Tests
• Docker Support

(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 (v3.4.5)
• PostgreSQL

Or optionally, if running with containerization:

• Docker Desktop

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 with Docker

To build and run the application along with PostgreSQL in Docker containers:

• Make sure Docker Engine / Docker Desktop is running.
• Launch the services:

docker compose up --build

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

To stop the containers:

docker compose down

Run tests

To run tests, run the following command:

  rspec

Or inside the Docker container:

docker compose exec web bundle exec rspec

(back to top)

👥 Author

👤 Elson Otake

• GitHub: elsonotake
• X: @elsonotake
• LinkedIn: elsonotake

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

• Original design idea by Gregoire Vella on Behance
• Monkik and flaticon immensely for the wonderful icons used by the app
• Microverse
• W3Schools
• Stack Overflow
• Render

(back to top)

📝 License

This project is MIT licensed.

(back to top)