Skip to content

ScoutSG/scout-competitions

Repository files navigation

Build your dream team.

AY22/23 CS3216 Final Project

Give it a try now!

Table of Contents

  1. Overview
  2. Team Members
  3. Submission
  4. User Guide
  5. Developer Guide
  6. Tech Stack

Overview

Scout is a responsive web app with a mission to help university students find and form teams rapidly for undergraduate competitions.

On Scout, users can discover competitions, lead or join a team, invite friends to their team, and share their team's openings for others.

Students generally face difficulties finding suitable teammates to join competitions - some are solo participants, while others may have a partial group but face difficulties in completing the team. Scout is here to reduce this problem as it provides a platform for students to discover teams or teammates who complement their personalities and skill sets, so that they can achieve their goals for the competition

Feel free to give it a try at: https://scoutsg.vercel.app/

Team Members

Name Contributions
Didymus Ne Full Stack Developer, Marketing, User Interviews
Keith Gan Full Stack Developer, Product Designer
Lee Yong Ler Backend Developer, Marketing
Lye Wen Jun Full Stack Developer, User Interviews

Submission

The following files are in the root folder:

User Guide

Watch our product demo here

  1. Discover Competitions

Find competitions of your interest.

  1. View Competition Details

  1. Lead a team

  1. Ask Effective Questions

  1. Set Up Automatic Telegram Group

  1. Share team details

  1. Directly invite peers to team

  1. Request to join team

  1. View personal Profile, Groups, and Requests

  1. Light / Dark Mode Scout is available in light and dark mode.

Developer Guide

To run this application locally, first clone this repository.

git clone https://github.com/cs3216/2022-final-project-2022-fp-group-4.git

Then go to the scout folder and run:

npm run dev

Tech Stack

Scout is built with NextJS, Prisma, Typescript, Chakra UI and the Telegram API.