Private Events

Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
• Quick Start
• Installation
• Testing
• Built With
• Contributing
• Author
• Acknowledgements
• 📝 License

About The Project

Private events is an event management web app built as a part of ruby on rails module of Microverse main curriculum. In this app, users can create a new event or browse through all the existing events and attend (or unattend) them. The events attended by an user are listed under previously attended events or upcoming events in the users' profile page.

Main Features of the App

• Users can create an account for which just entering a name and an unique username is enough. No passwords required.
• Users can browse through all the existing events created by other users.
• Users can see the details of an event and choose to attend the event.
• Users can always choose to unattend the events they choose to attend earlier.
• A user can create new event.

Live demo

Here is the live demo of my work.

Built With

• Ruby version 2.7.1
• Ruby on Rails version 6.0.3.2

Quick Start

Prerequisite

• Install Ruby (installation guide)
• Install Ruby on Rails (installation guide)
• Git and Github

Get a local copy with:

git clone git@github.com:praz99/private_events_self.git

Installation

After cloning the app, enter following commands in your terminal.

bundle install

yarn install --check-files

rails db:create

rails db:migrate

rails server

Open https://localhost:3000/ in your browser

Testing

To test the project

• Navigate to the directory where the project is located.
• Open terminal in this directory.
• Start testing by using rspec command.

Contributing

Contributions, issues and feature requests are welcome! Start by:

• Fork the project.
• Clone the project to your local machine.
• cd into the project directory.
• Run git checkout -b your-branch-name.
• Make your contributions.
• Push your branch up to your forked repository.
• Open a Pull Request with a detailed description to the development branch of the original project for a review.

Author

👤 Prajwal Thapa

• LinkedIn: prazwal-thapa
• GitHub: praz99
• Twitter: @thapa_praz
• E-mail: [email protected]

Show your support

Give a ⭐️ if you like this project!

Acknowledgements

• The Odin Project
• Microverse

License

• This project is MIT licensed.