Skip to content

Latest commit

 

History

History
159 lines (111 loc) · 5.97 KB

README.md

File metadata and controls

159 lines (111 loc) · 5.97 KB
Raw

Event Mint : Seamless Event Experience

eventmint

Event Mint is a dynamic web application built for managing events in educational institutions such as schools, colleges, and universities. Inspired by platforms like BookMyShow, it simplifies event discovery, registration, payments, and management for organizers and attendees alike.

🚀 Live Demo & Backend Links

🛠️ Tech Stack

React Node.js Express.js MongoDB Stripe HTML5 CSS3 JavaScript

  • Frontend: React.js, HTML5, CSS3, JavaScript
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Payment Gateway: Stripe API

✨ Key Features

  • 🎫 Event Listings: View events categorized by type, date, and location.
  • 🔐 User Registration: Secure and seamless registration for attendees.
  • 🪑 Seat Reservation: Real-time seat availability and reservations.
  • 💳 Payment Integration: Secure payment gateways (e.g., Stripe) for event registration.
  • 👥 Attendee Management: Event organizers can track and manage attendee details.
  • 📱 Responsive Design: Fully responsive design for all devices (mobile, tablet, desktop).
  • 🔍 Event Discovery: Search and filter options for quick event discovery.
  • 🔥 Dynamic Content: Image sliders and event cards for enhanced UX.

💻 How to Contribute

We welcome contributions to improve EventMint! Whether you're adding features or fixing bugs, your contribution will make this project better. Follow the steps below to get started:

  1. Fork the Repository:

    • Go to the repository on GitHub and click the "Fork" button.

      • Dropdown menu-- "+ Create a new Fork"

      step1

      • Dont change the suggested repo name and just click on "Create Fork" button.

      step2

      • Congo! 🎊 you have successfully done the 1st step!

    step3

  2. Now, from your forked repo, click on the "<> code" button and copy the url:

    • the forked url looks like this--
     https://github.com/<your  username>/eventmint.git

step4

  1. Open your IDE(Visual studio code or other), paste the above url in vs code terminal or git bash and navigate into the directory: 
     git clone https://github.com/<your  username>/eventmint.git
 cd eventmint
  2. Add a Remote upstream to original repo for reference: 
    git remote add upstream https://github.com/samyakmaitre/eventmint.git
  3. Verify remote origin and upstream: 
    git remote -v
  • the following response appear:
 origin  https://github.com/<your username>/eventmint.git (fetch)
 origin  https://github.com/<your username>/eventmint.git (push)
 upstream        https://github.com/samyakmaitre/eventmint.git (fetch)
 upstream        https://github.com/samyakmaitre/eventmint.git (push)
  1. Always make a pull from the upstream repository to your main branch to keep it updated with the original repository. 
    git pull upstream main
  2. Install the dependencies:
  • Ensure you execute this cmd in the eventmint directory 
    npm install
yarn start
  1. Create a new branch: 
    git checkout -b <feature-branch>
  2. Work on the issue:
  • Perform the proposed changes in your new branch and ensure everything works.
  1. Track your changes: 
    git status
git diff
  2. Stage and Commit your changes:
git add .
git commit -m "Add feature: <description>"
  1. Ensure you push the committed changes in your feature branch to your own remote repository 
    git push -u origin <feature-branch>
  2. Next, create a pull request, click on compare and pull requests
    • Go to your forked repository on GitHub, click "Compare & pull request."
    • Provide a descriptive title and summary for your PR.
    • Click on "Create pull request" to submit your PR for review!

🎇 Congratulations🎉, you have made a PR to the Eventmint. Wait for your submission to be accepted and your PR to be merged by a maintainer.

🏆 Contribution Guidelines

  • Ensure that the code you write follows best practices and is well documented.
  • Test your changes before submitting a pull request.
  • Keep your branch updated with the main branch to avoid conflicts.
  • Be clear and concise in your pull request titles and descriptions.

📞 Contact

Feel free to reach out with questions or suggestions!

🌟 Show your support

Give this project a ⭐ if you find it engaging! Feel Free to reach out. Happy Coding!😄😊