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 with online conferences and events.!
Experience the <Vibey/> platform live by visiting our website: here
<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.
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.
- 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? go and check out how-to-contribute an official guide by Github
or
You can start directly from here
git clone https://github.com/<YOUR_USERNAME>/vibeycd vibeypnpm iNote: If you don't have pnpm installed in your system then run this command
npm i -g pnpmto install pnpm.
5. Create a .env.local file and copy the credentials from .env.example and paste it into the .env.local file.
pnpm devPORT=5000
UI_ENDPOINT=http://localhost:3000
MONGODB_USER='YOUR_MONGO_USERNAME'
MONGODB_PASSWORD='YOUR_MONGO_PASSWORD'Note: Get your Mongodb credentials from here
cd vibey/serverpnpm ipnpm devVisit https://localhost:3000 in your web browser to access the application 🎉.
Make sure to follow the project's code of conduct.
The core team members working on <Vibey/> are:
Are you looking for ways to contribute to <Vibey/>? Here are thirty issues you can work on as part of the GSSoC (GirlScript Summer of Code) program:
-
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.
These will be added soon.
These will be added soon.
For the easiest deployment of your Next.js app, we recommend using Vercel. Check out their Next.js deployment documentation for more details.
This project is licensed under the MIT License. See the LICENSE.md file for more information.
Please show your support for the <Vibey/> project by leaving a ⭐️ star on our GitHub repository.
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! 🍻
Vibey is a community driven initiative to find online conferences and events for developers. It is a web app that lets you find online events and conferences that are happening around the world. This project is still in its early stages and we are looking for contributors to make this project a success.
Check out the website: here
- Fork the repo. You can find the button on the top.
- Clone the repository using the command
git clone https://github.com/<USERNAME>/vibey
-
Open the project in your IDE(eg. VS Code).
-
Run
pnpm installto install all dependencies -
Run
pnpm devto start the application -
Visit https://localhost:3000 to view the application
-
Run installation steps
-
Find Issue to work on or create a new issue for feature request or bug
-
Create a new branch for your feature
git checkout -b feature-name -
Make your changes
-
Commit your changes
git commit -a -m "Add some feature" -
Push to the branch
git push origin feature-name -
Create a new pull request
- Issue: Update README.md
Description: Review and update the project's README.md file to provide comprehensive
documentation and instructions for developers and contributors for making contribution to the
project.
- Issue: Shift the Backend from Appwrite to Node.js
Description: Remove the backend from Appwrite ( Backend As a Service ) to proper backend built
using Node.js and Experss.js, and NoSQL database that is MongoDB.
- Issue: Implement contributors authentication using OAuth
Description: Integrate OAuth authentication to allow users to sign in with popular platforms
such as Google, Facebook, or GitHub.
- Issue: Add Dashboard for Contributors for adding events on client side
Description: Add the contributor's dashboard so contributors can add, update and delete events
which they have added on Vibey and customization options, such as a profile picture or
contributors details like name, email, role and social for authenticity.
- Issue: Add Dashboard for Contributors for adding events on server side using MongoDB database
Description: Add the contributor's dashboard so contributors can add, update and delete events
which they have added on Vibey and customization options, such as a profile picture or
contributors details like name, email, role and social for authenticity.
- Issue: Add Custom form for adding events on client side in dashboard
Description: Add the custom form in dashboard so contributors can add events, CFPs and
hackathons.
- Issue: Add sever side code for events
Description: Add server side code for adding, updating, deleting, and fetching Events,
Hackathons and CFPs on client side.
- Issue: Add Client side code for fetching events in Events Page
Description: Add client side code for fetching Events and display events on Event page fetched
from server side.
- Issue: Add client side code for fetching CFPs in CFP Page
Description: Add client side code for fetching CFPs and display cfps on CFP page fetched
from server side.
- Issue: Add client side code for fetching Hackathons in Hackathon Page
Description: Add client side code for fetching Hackathons and display hackathons on Hackathon
page fetched from server side.
The easiest way to deploy your Next.js app is to use Vercel
Check out their Next.js deployment documentation for more details.
This project is licensed under the MIT License - see the LICENSE.md file for details
This project needs a ⭐️ from you. Don't forget to leave a star ⭐️
Thanks a lot for spending your time helping vibey grow. Thanks a lot! Keep rocking 🍻