Skip to content

momo-87/quoter

Repository files navigation

📗 Table of Contents

📖 Quoter APP

Quoter is a single-page, reactive quote editor. With quoter, you can create, update and delete quotes. When clicking on a quote, you access the page to create, update and delete dates. On each date, you can add line items. Every time you create, update, or delete a line item, the quote total gets updated.

🛠 Built With

Tech Stack

Key Features

  • SPA-like behavior using Turbo Drive and Turbo Streams.
  • Real-time updates with Turbo Streams and Action Cable, enabling users to receive instant notifications without full page reloads.
  • Reusable design system using the BEM methodology.

💻 Getting Started

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

Prerequisites

In order to run this project you need:

  • A browser of you choice.
  • A text editor of your choice.
  • Install ruby gem and depencies on your local system
  • Install Postgresql

Setup

Clone this repository to your desired folder:

  • Use the following Commands:
    • git clone https://github.com/momo-87/quoter.git
    • cd quoter

Usage

  • Create the .env file and set your PostgreSQL connexion parameter as environment variables:
    • USER_NAME
    • PASSWORD
  • Install the required gem libraries by running: bundle install
  • To start the project, run: bin/dev

Run tests

  • Use the folling command to run the integration tests: bin/rails test:all

👥 Authors

👤 Christian Momo

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page

⭐️ Show your support

If you like this project, give it a star and share it.

🙏 Acknowledgments

This project served as a great way to solidify my Rails (Hotwire & Redis) knowledge thanks to the fantastic tutorial by Alexandre Ruban

📝 License

This project is MIT licensed.

(back to top)