Skip to content

Latest commit

 

History

History
176 lines (105 loc) · 7.87 KB

README.md

File metadata and controls

176 lines (105 loc) · 7.87 KB
Raw

Vibey Banner

License Issues Contributors Forks Stars

Typing SVG

Vibey is a community-driven initiative to find conferences, meetups and workshops for developers. Our web app is designed to empower developers like you to explore a multitude of captivating online events, right at your fingertips.

While is still in its early stages, we are fueled by the collective ambition and expertise of our contributors. Together, we strive to transform this project into a resounding success. Whether you're an experienced developer or just starting your coding journey, we welcome your valuable contributions with open arms.

Join us on this exhilarating mission to revolutionize the way developers discover and engage online/offline conferences and events.!


🛠️ Technologies Used

<Vibey/> is built using the following technologies:

  • React JS - A popular JavaScript library for building user interfaces.
  • Next.js - A powerful React framework for server-side rendering and static site generation.
  • Tailwind CSS - A highly customizable CSS framework for rapid UI development.
  • TypeScript - A typed superset of JavaScript that enhances development experience and code quality.
  • MongoDB - A flexible and scalable NoSQL database for storing application data.

👇 Prerequisites

Before getting started with <Vibey/>, make sure you have the following software installed on your machine:

  • Node.js - A JavaScript runtime environment for executing server-side and build scripts.
  • Git - A distributed version control system for managing your source code.
  • pnpm - A fast and efficient package manager for Node.js projects.

🚀 Quick start

🛠️ Installation

1. Fork this repository by clicking on the fork button as shown below, at the top right section of this page

image

else fork directly from here

2. Clone the repository to your local machine using the following command:

git clone https://github.com/<YOUR_USERNAME>/vibey

3. Navigate to the project directory in your IDE or terminal.

cd vibey

4. Install the project dependencies by running the following command:

pnpm i

Note: If you don't have pnpm installed in your system then run this command npm i -g pnpm to install pnpm.

Start Client

5. Create a .env.local file and copy-paste the credentials from .env.example into it

7. Start the application using the following command:

pnpm dev

Start Server

8. Go to the server folder inside the project.

9. Create a .env file inside the server and add the following

PORT=5000
UI_ENDPOINT=http://localhost:3000
DB='YOUR_MONGO_CREDENTIALS'

Note: Get your Mongodb credentials from here

10. Open a new terminal and naviagte to the server folder

cd vibey/server

11. Run the below command to install the server dependencies:

pnpm i

12. Now run the below command to start the server:

pnpm dev

Visit https://localhost:3000 in your web browser to access the application 🎉.

👥 Issues for Contributors

Are you looking for ways to contribute to <Vibey/>? Here are few issues you can work on:

Level 3 Issues

  • 1. Update README.md: Review and update the project's README.md file to provide comprehensive documentation and instructions for developers and contributors.

  • 2. Shift the Backend from Appwrite to Node.js: Remove the Appwrite backend and build a backend using Node.js, Express.js, and MongoDB.

  • 3. Implement contributors authentication using OAuth: Integrate OAuth authentication to allow users to sign in using popular platforms like Google, Facebook, or GitHub.

  • 4. Add Dashboard for Contributors for adding events on the client side: Create a dashboard where contributors can add, update, and delete events they have added to Vibey. Include customization options such as profile pictures and contributor details.

  • 5. Add Dashboard for Contributors for adding events on the server side using MongoDB database: Develop a server-side dashboard for contributors to manage events using MongoDB as the database.

  • 6. Add Custom form for adding events on the client side in the dashboard: Enhance the contributor's dashboard by adding a custom form for adding events, CFPs (Call for Papers), and hackathons.

  • 7. Add server-side code for events: Implement server-side code for adding, updating, deleting, and fetching events, hackathons, and CFPs on the client side.

  • 8. Add client-side code for fetching events in the Events Page: Enhance the Events Page by adding client-side code to fetch and display events fetched from the server side.

  • 9. Add client-side code for fetching CFPs in the CFP Page: Improve the CFP Page by adding client-side code to fetch and display CFPs fetched from the server side.

  • 10. Add client-side code for fetching Hackathons in the Hackathon Page: Enhance the Hackathon Page by adding client-side code to fetch and display hackathons fetched from the server side.

More will be added soon.

💪 Contributions

  • Submit bugs and feature requests, and help us verify as they are checked in
  • Review the documentation and make pull requests for anything from typos to additional and new content
  • If you are interested in fixing issues and contributing directly to the code base, please go through the CONTRIBUTING.md file, where all the guidelines have been mentioned that will guide you to make your contribution.

Note: New to open source contributions? check out how-to-contribute guide by Github

👥 Team

The team members working on <Vibey/> are:

Code of Conduct

Make sure to follow the project's code of conduct.

🛡️ License

This project is licensed under the MIT License. See the LICENSE.md file for more information.

🙏 Support

Please show your support for the <Vibey/> project by leaving a ⭐️ star on our GitHub repository.

💪 Thanks to all Contributors

A big thank you to all the contributors who have dedicated their time and effort to help <Vibey/> grow. We appreciate your contributions and support! Keep rocking! 🍻

Contributors

239682688-0c5debf5-d414-4916-87d8-e1a710773ae3