Skip to content

Latest commit

 

History

History
119 lines (70 loc) · 2.67 KB

README.md

File metadata and controls

119 lines (70 loc) · 2.67 KB

Team Maker

Team Maker Thumbnail

MIT License

Live Link | Demo

The problem Team Maker solves

A real-world issue we've encountered while looking for a team to participate in a hackathon is finding a random teammate or team and synchronising our abilities as best we can, which is extremely difficult to do with people we don't know anything about. Team Maker attempts to address this issue by allowing users to search for teams using multiple filters and learn about one another via user portfolios.

Features

  • User and Admin Authentication.
  • Creation of Teams.
  • Searching for Teams.
  • Colloboration with Teams( Chat functionality ).
  • List of all events like hackathons, competitions(for now we only support few events).
  • Custom addition of events by Admin.
  • Team and User Profiles.

Tech Stack

Client: React Js, Redux, Material UI

Server: Node Js ( Express Js )

Database: MongoDB

Others: Socket.io, AWS S3

Environment Variables

To run this project, you will need to add the following environment variables to your .env file in root directory.

MONGO_URI

JWT_SECRET

Run Locally

Clone the project

git clone https://github.com/veerreshr/team-maker.git

Go to the project directory

cd team-maker

Install dependencies

npm install

Go to the fronend directory

cd frontend

Install dependencies

npm install

Go to the root directory

cd ..

Start the server

npm run dev

Also refer Contributing-gitflow for more information

Roadmap

  • Add ESLint
  • Landing Page
  • User Profile
  • Event Section
  • Team Filtering
  • Chat Implementation
  • Dockerize the application
  • Implement Testing
  • Voice/Video call Implementation(Optional)
  • Kanban Boards( optional )

Support

For support, Please email us at veerreshr@gmail.com

License

MIT