Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a README for the Project #1

Open
aryad14 opened this issue Oct 2, 2024 · 9 comments
Open

Create a README for the Project #1

aryad14 opened this issue Oct 2, 2024 · 9 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest

Comments

@aryad14
Copy link
Member

aryad14 commented Oct 2, 2024

EventGuru

EventGuru is an intuitive event management platform built using Next.js, designed to streamline the process of organizing and managing events. The app provides a user-friendly interface for event organizers to create, customize, and promote events effortlessly. With features such as real-time scheduling, attendee management, and ticketing integration, it simplifies every aspect of event planning.

A good Readme which explains the project is expected

@aryad14 aryad14 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 2, 2024
@Nitin-cyperpunk
Copy link

if possible will u able to host this project so it could be better to create readme file

@aryad14
Copy link
Member Author

aryad14 commented Oct 4, 2024

Sure! The website link is not updated on the repo

@MadhurSaluja
Copy link

@aryad14 hi, if no one is working on it yet, I can start working on it right away. Can you pls assign it to me

@MadhurSaluja
Copy link

MadhurSaluja commented Oct 7, 2024

@aryad14
I just had a few question while I am working on it :

  1. Do u have any support email or contact info for people?
  2. According to what I understand the website is not hosted yet so Do u want me to create a section for DEMO which you can update latter with the link?

@aryad14
Copy link
Member Author

aryad14 commented Oct 7, 2024

@MadhurSaluja
There is no need of adding any contact info in the README.
You can add

  • Features of the project,
  • Screenshots of creating or booking a seat for an event,
  • Tech Stack,
  • Quick Start guide to setup project in local environment, etc.

Also the project is hosted, you can Click Here to visit the website or check the link in the repo itself.

@MadhurSaluja
Copy link

@aryad14 Thanks a lot for the detailed info.

@MadhurSaluja
Copy link

MadhurSaluja commented Oct 7, 2024

Hi @aryad14 I have generated a PR, Can u pls check and let me know if its good to go, If yes pls also add hacktoberfest accepted label :)

@aryad14
Copy link
Member Author

aryad14 commented Oct 9, 2024

Hello @MadhurSaluja
I reviewed your PR and requested some changes. Be sure to check it once

@MadhurSaluja
Copy link

@aryad14 Will do it by today

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants