Moathal / private-event

a site similar to a private Eventbrite which allows users to create events and then manage user signups.

📗 Table of Contents

• 📖 About the Project
  • 🔖 Learning objectives
  • 🛠 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
• 📝 License

📖 [Private-events]

A site lets user create events private or public, and attend events. An event can be attended by many users, and take place at specific location, date and time. All pages are real time updated and all uses are notified thanks to noticed and hotrails gems. Tried to use as much association case in the database as possible to push active record to its peak. Used sass, Bootstrap and stimulus for styling and responsiveness all embedded in webpack.

🛠 Built With

• Ruby on Rails (RoR)

Tech Stack

Database

• PostgreSQL
• Devise
• Noticed
• Hotwire
• Redis
• Bootstrap
• SASS
• Webpack

Key Features

• [Delploy on render] - realtime updates and notifications
• [Improve security] - Responsive

(back to top)

🚀 Live Version

• Comming soon

(back to top)

🚀 Presenation video

• Coming soon

(back to top)

💻 Getting Started

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

Prerequisites

• A web browser like Google Chrome.
• A nodeJS and yarn.
• A code editor like Visual Studio Code with Git, Ruby and redis.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Ruby installation (on UBUNTU and MAC PC's or windows only)

$ ruby --version && irb

Finally you can check if redis installed by this command.

redis-server --version

Install

In the terminal, go to your file directory and run this command.

$ git clone https://github.com/melashu/hotel-room-reservation.git

$ gem install bundler

$ bundle install

$ rails db:create db:migrate

Run tests (SOON)

To install rspec, in the terminal kindly run this command

$ gem install rspec

To run tests, please run this command

$ rspec ./spec/#{filename}_spec.rb

Run the app

If its your first time to run the app run this command

$ bin/setup

The app is using redis so first run the redis server

$ redis-server

To run the app you need to run this command in the terminal

$ bin/div

Usage

To run the project, execute the following command:

` $ rails server`

Run tests

To run tests, run the following command:

 $ rspec

(back to top)

👥 Authors

👤 Mo'athal S. Kachi

• GitHub: @githubhandle
• LinkedIn: LinkedIn

🔭 Future Features

• [Delploy on heroku] - Delploy on heroku
• [Improve security] - Improve security
• [ Add testes ] - Add testes

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give as a star! ⭐️

(back to top)

🙏 Acknowledgments

• Microverse
• Coding Partners
• Code Reviewers

❓ FAQ

• [How I can run this project?]

  • [After cloning repository, run bin/setup then in another terminal redis-server and finally bin/dev.]

(back to top)

📝 License

This project is MIT licensed.