Rate My Hackathon

A simple web app that allows hackers to rate hackathons they've participated in.
View application »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
   • How to Run
3. Roadmap
4. Contributing

About The Project

Rate my Hackathon is a MERN stack web application that allows hackers to knowledgeably choose which hackathons to participate in. Hackers can leave a review on hackathons they have completed as well as view other reviews left by hackers.

Built With

• React
• Express
• MongoDB
• Node.js

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

   git clone https://github.com/lumamoto/rate-my-hackathon.git

2. Install NPM packages

   npm install
   cd frontend && npm install
   cd ../backend && npm install

How to Run

To run the app locally, starting up both the frontend and backend concurrently:

npm run dev

Roadmap

• Add a hackathon to DB
• Add a review to DB
• Create home page
• Adjust styling
  • Add Hackathon page
  • Add Review page
  • View All Hackathons page
  • View Hackathon page
  • Home page
• Implement search functionality
• Add auth (via GitHub and/or Google?)
  • Upvote and downvote reviews
  • Flag a review to be removed
  • Create individual profile pages
    • Edit/delete hackathons you've added
    • Edit/delete reviews you've written
• Deploy to Heroku

Contributing

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

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