Skip to content

Latest commit

 

History

History
122 lines (93 loc) · 5.74 KB

README.md

File metadata and controls

122 lines (93 loc) · 5.74 KB
Raw

GG Extensions

⭐️ Show Your Support!

Before you get started, please:

  1. Star this repository by clicking the "Star" button at the top right corner.
  2. Follow the GitHub profile of the project owner: ankit071105.
  3. JOIN US Whatsapp Group:- Open Source Community.

By doing this, you support the project and help grow our community!

🎉 Accepted for GirlScript Summer of Code 2024

Congratulations! GG Extensions has been selected for participation in GirlScript Summer of Code 2024. We're excited to have you on board to contribute and learn together!

This repository serves as a platform for newcomers and seasoned developers alike to enhance their knowledge and skills by working on small to large web projects. Whether you're diving into web development for the first time or looking to expand your portfolio, GG Extensions offers a supportive community and a variety of opportunities to grow.

🚀 How to Get Started?

Getting started with GG Extensions is easy! Follow these steps to jump right in:

  1. Explore Project Ideas: Browse through the existing project ideas or propose your own by opening an issue. We welcome a diverse range of project proposals and aim to match contributors with projects that align with their interests and skill levels.
  2. Join the Community: Connect with fellow contributors and mentors in our community channels. Whether you have questions, need guidance, or want to share your progress, our community is here to support you every step of the way.
  3. Choose Your Project: Once you've identified a project that interests you, let us know! We'll assign you the issue and provide any additional resources or information you may need to get started.
  4. Start Contributing: Dive into the project, work on your assigned tasks, and collaborate with your peers. Don't hesitate to ask for help or feedback along the way—we're all here to learn and grow together.

🛠 Installation and Usage

To set up the project locally, follow these steps:

1. Clone the Repository

git clone https://github.com/ankit071105/Ticket-Booking.git

2. Frontend Setup

The frontend of the project is located in the Ticket-booking folder.
Open the project in VS Code and click Go Live to run the frontend.

3. Backend Setup

Navigate to the server folder.
Install the required dependencies:

cd server
npm install

Set up environment variables by creating a .env file in the server folder with the following variables:

DB_URI=your_mongoDB_connection_URI<br>
DB_NAME=your_database_name<br>

Run the backend server using:

npm run dev

4. Running the Project

Once both the frontend and backend are set up, the project will be accessible on the defined local port.

🛠 How to Contribute?

Contributing to GG Extensions is a rewarding experience that allows you to sharpen your skills, gain practical experience, and make meaningful contributions to real-world projects. Here's how you can get involved:

  • Coding: Contribute code to existing projects or propose new projects to work on. Whether you're a frontend developer, backend developer, or full-stack developer, there's a place for you to contribute your expertise.
  • Documentation: Improve project documentation, write tutorials, or create developer guides to help others understand and contribute to the project more effectively.
  • Testing: Help ensure the quality and reliability of our projects by testing new features, identifying bugs, and providing feedback on improvements.
  • Design: If you have a knack for design, contribute your skills to create user-friendly interfaces, design project logos, or enhance the overall visual appeal of our projects.

🔄 Submitting a Pull Request

To submit your contributions, follow these steps:

  1. Star the repository: Don't forget to show your support by starring this repository!
  2. Fork the Repository: Click the "Fork" button at the top right corner of the repository to create your own copy.
  3. 📥Clone the repository:
   git clone https://github.com/ankit071105/Ticket-Booking.git
  1. 📂 Change the working directory:
   cd Ticket-Booking
  1. 🔗 Add a reference to the original repository.
   git remote add upstream https://github.com/ankit071105/Ticket-Booking.git
  1. ⬇️ Always take a pull from the upstream repository to your main branch to keep it up-to-date with the main project (updated repository).
   git pull upstream main
  1. 🌿 Create a Branch: Create a new branch for your changes:
   git checkout -b my-feature
  1. Make Changes: Make your desired changes to the codebase.
  2. 📥 Commit Changes: Commit your changes with a descriptive commit message:
   git commit -m "Add new feature"
  1. ⬇️ Push Changes: Push your changes to your forked repository:
   git push origin my-feature
  1. Submit a Pull Request: Go to your forked repository on GitHub and submit a pull request. Be sure to provide a detailed description of your changes and why they are necessary.

🎉 Voila! You have made a PR to the Ticket-Booking project. Sit back patiently and relax while the project maintainers review your PR.

❤️ Our Valuable Contributors

  • We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating this project to greater heights.
  • Make sure you show some love by giving ⭐ to our repository.