📗 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

📖 Blue-ray Pay

Blue-ray Pay is a classic example of a payment tracking application, built using the Ruby on Rails Frawework. The application is a fully functional app that allows users to sign-up/log-in, create different categories & create different transactions that belong to one or many categories.

🛠 Built With

Tech Stack

• Ruby
• Ruby on Rails
• Postgresql (Database)
• Haml
• Tailwind
• RSpec & Capybara for testing

Key Features

• Athentication (using devise)
• Image upload, validation & processing (using "shrine" & "image_processing" gems)
• Responsive design with tailwind

(back to top)

🚀 Live Demo

• Live Demo
  This website is currently down

Screenshots

Mobile

Desktop

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

• Basic knowledge of the command line.
• Ruby installed on your device.
• Ruby on Rails installed on your device.
• Postgresql Database, you can follow this link, choose your system & follow the provided instructions.
• ImageMagic installed on your device for manipulating the uploaded image via the "image_processing" gem.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Peter1907/blue-ray-pay.git

Install

Install this project with:

  cd blue-ray-pay
  bundle install

Install tailwindcss gem to work properly:

  rails tailwindscss:install

Usage

To run the project, execute the following command:

• To run the project in your browser, run:

  rails server

Or for short:

  rails s

• if you want to modify styles & let tailwind compile on save run:

  rails tailwindcss:watch

Run tests

• You would have the necessary gems added to the Gemfile
• Open the terminal in the repo folder on your machine & run bundle install if you haven't already done so by this point
• In the terminal you have the option to run the tests for:
  • An entire folder, using the rspec spec command.
  • A sub-folder, using the rspec spec/models for example.
  • A single file, using the rspec spec/requests/post_spec.rb for example.

(back to top)

👥 Authors

👤 Peter Beshara

• GitHub: @Peter1907
• Twitter: @Peter_Beshara_
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• To be added..

(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

• Microverse for overseeing the project
• Original design idea by Gregoire Vella on Behance
• Inspiration, Dedication

(back to top)

📝 License

This project is MIT licensed.

(back to top)