<Vibey/>
is built using the following technologies:
Before getting started with <Vibey/>
, make sure you have the following software installed on your machine:
fork
button as shown below, at the top right section of this pageelse fork directly from here
git clone https://github.com/<YOUR_USERNAME>/vibey
cd vibey
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
.env.local
file and copy-paste the credentials from .env.example
into itpnpm dev
Start Server
.env
file inside the server and add the followingPORT=5000
UI_ENDPOINT=http://localhost:3000
DB='YOUR_MONGO_CREDENTIALS'
Note: Get your Mongodb credentials from here
cd vibey/server
pnpm i
pnpm dev
Visit https://localhost:3000 in your web browser to access the
Are you looking for ways to contribute to <Vibey/>
? Here are few issues you can work on:
[x] 1. Update README.md: Review and update the project's README.md file to provide comprehensive documentation and instructions for developers and contributors.
[x] 2. Shift the Backend from Appwrite to Node.js: Remove the Appwrite backend and build a backend using Node.js, Express.js, and MongoDB.
[x] 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.
[x] 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.
[x] 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.
[x] 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.
[x] 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.
Note: New to open source contributions? check out how-to-contribute guide by Github
The team members working on <Vibey/>
are:
Make sure to follow the project's code of conduct.
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! 🍻