sra1kumar-NULL/fossfolio

Discover, host and manage Hackathons all in one place.

Foss Folio

About The Project

FossFolio is and open source web application for people to Find, Host and Manage Hackathons.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

Find Hackathons

Users can go to the website and see a directory of all the published hackathons which are ongoing and upcoming. Users can find the ones they like to join and register for the event on the site by filling in the necessary information. Users get a dashboard where the can see all the hackathons they've registered for and options to edit their profile information.

Host Hackathons

Users who want to host hackathons can use the "Create Hackathon" option and fill in the necessary details in a form and publish the event. Upon publishing everyone can see that event on the site.

Managing Created Hackathons

Users who are hosting hackathons will get a detailed dashboard that displays the following data:

• Total number of participants
• Total number of teams
• Number of student and professional applicants
• List of all the participants and teams with details of participants

(back to top)

Built With

• React Js
• Next Js
• Nest Js
• Typescript

(back to top)

Getting Started

Prerequisites

You need to install

1. Node v16
2. pnpm

Installation

1. Clone the repo

   git clone https://github.com/DarkPhoenix2704/fossfolio.git

2. Install all the NPM packages all the applications.

   We are using Yarn workspace and turborepo to manage the applications in monorepo.

   pnpm install

3. Copy the .env.example for each applications to .env in the same directory and fill the values required

4. Start the web application dev server and open http://localhost:3000

   pnpm --filter  web dev

5. Start the api server and open http://localhost:3001

   pnpm --filter  api dev

6. Start the database http://localhost:5432

   docker compose up

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)