Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tejasnasre committed Dec 25, 2024
1 parent 069449d commit 6cd56a8
Showing 1 changed file with 5 additions and 142 deletions.
147 changes: 5 additions & 142 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,151 +1,14 @@
<div align="center">
# Nemeet Moved 🚀

# `NexMeet Event Platform`
This project has been moved to a new repository under our organization.

<i>NexMeet is an open-source event platform where you can discover a wide range of events, from non-technical to technical. We cover it all! The best part is, we offer an easy-to-use event management system for organizers, and they can also find event spaces nearby.</i>
👉 [Click here to visit the new repository](https://github.com/nexmeet/nexmeet)

</div>

<div align = "center">
<br>

[![License: Apache](https://img.shields.io/badge/License-Apache-red.svg)](http://www.apache.org/licenses/)

<table align="center">
<thead align="center">
<tr border: 1px;>
<td><b>🌟 Stars</b></td>
<td><b>🍴 Forks</b></td>
<td><b>🐛 Issues</b></td>
<td><b>🔔 Open PRs</b></td>
<td><b>🔕 Close PRs</b></td>
</tr>
</thead>
<tbody>
<tr>
<td><img alt="Stars" src="https://img.shields.io/github/stars/TejasNasre/nexmeet?style=flat&logo=github"/></td>
<td><img alt="Forks" src="https://img.shields.io/github/forks/TejasNasre/nexmeet?style=flat&logo=github"/></td>
<td><img alt="Issues" src="https://img.shields.io/github/issues/TejasNasre/nexmeet?style=flat&logo=github"/></td>
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/TejasNasre/nexmeet?style=flat&logo=github"/></td>
<td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/TejasNasre/nexmeet?style=flat&color=critical&logo=github"/></td>
</tr>
</tbody>
</table>
</div>

<div align="center">

## 💻 `Tech Stack`

![Next.js](https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=next.js&logoColor=white)
![Shadcn UI](https://img.shields.io/badge/Shadcn%20UI-%23FF69B4?style=for-the-badge&logo=github&logoColor=white)
![Tailwind CSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)
![Supabase](https://img.shields.io/badge/Supabase-3954E1?style=for-the-badge&logo=supabase&logoColor=white)

</div>

## 🏆 `Featured In`

<div align="center">

<table>

<tr>
<th>Event Logo</th>
<th>Event Name</th>
<th>Event Description</th>
</tr>
<tr>
<td><img src="https://gssoc.girlscript.tech/GS_logo_White.svg" width="200" height="auto" loading="lazy" alt="GSSoC-EXT"/></td>
<td>GirlScript Summer of Code EXT</td>
<td>GirlScript Summer of Code Extd is a 1-month long
#OpenSource program by GirlScript Foundation.
1st Oct - 10th Nov 2024</td>
</tr>

</table>

</div>

## `Key Features`

- Discover Events - Find a wide range of events from non-technical to technical
- Event Management System - Organizers can easily manage their events
- Event Spaces - Find event spaces nearby

## `Setup and Installation`

<!-- YOU CAN REFER TO THE FOLLOWING VIDEO FOR GUIDED SETUP :
<video controls src="public/GIT-RE Project Setup.mp4" title="Git-re Setup and Installation Video"></video> -->

Follow these steps to set up NexMeet your local machine:

1. **Fork the Repository & Clone it:**

- Fork the NexMeet repository to your GitHub account.
- Clone the forked repository to your local machine using the command:
```
git clone https://github.com/your-username/nexmeet.git
```
2. **Create a New Branch:**
- Create a new branch to work on using the command:
```
git checkout -b <branch_name>
```
3. **Install Dependencies:**
- Navigate to the project directory and install the dependencies using:
```
npm install
```
or
```
yarn install
```
4. **Start the Development Server:**
- Start the development server by running:
```
npm run dev
```
or
```
yarn dev
```
5. **Database and Authentication Setup:**
- Refer to the [LEARN.md](/LEARN.md) file for detailed instructions on setting up your database and authentication.
6. **You're Good to Go:**
- With the setup complete, you're ready to start exploring.
# `MAKE PR TO DEV BRANCH ONLY`
## `Upcoming Features`🎉
- [ ] add events to the gogle calendar
- [ ] add event reminders
- [ ] add event notifications
- [ ] add event feedback
- [ ] add event likes
- [ ] add event comments
- [ ] add event chat
- [ ] add event attendees
## `Contributing`
Contributions are welcome! Please open an issue or submit a pull request if you would like to help improve the project.
👉 [Click here to join community](https://chat.whatsapp.com/HD7kdkjzSP8Lf1nY6iTpnN)

> NOTE 1: Please abide by the [Contributing Guidelines](https://github.com/TejasNasre/nexmeet/blob/main/CONTRIBUTING.md).
Please update your bookmarks and follow the project in its new home!

> NOTE 2: Please abide by the [Code of Conduct](https://github.com/TejasNasre/nexmeet/blob/main/CODE_OF_CONDUCT.md).

> NOTE 3: We follow the following [coventional commit types](https://github.com/pvdlg/conventional-commit-types)

## `License`

Expand Down

0 comments on commit 6cd56a8

Please sign in to comment.