whisper-monorepo

💨 Whisper is an anonymous group-chat application for university class.

Idea

⚠️ Problem

• During lectures, students often find it difficult to ask questions directly to the professor.
  • Raising their hands and speaking up can be intimidating(especially in Korea!), and there are instances where students lose focus and miss important content during class.
• There is a lack of platforms for students to share their opinions and engage in discussions about specific lecture.
  • While platforms like “에브리타임” or “고파스” exist for university students, they are more general community platforms, and it's challenging for students in the same class to communicate effectively.

🪄 Solution

Create individual chat rooms for each specific lecture, allowing students to freely join the chat room corresponding to their class.

• In these chat rooms, all students can engage in discussions anonymously, enabling them to express their thoughts without hesitation.
• By having real-time chat rooms dedicated to each lecture, our platform facilitates quicker sharing of opinions and questions related to the course compared to traditional community platforms.

How to install

You should install Docker and docker-compose to run this project.
Normally, docker-compose is automatically installed with docker. If is not, download in here.

git clone https://github.com/COSE451-2023-2-Team2/whisper-monorepo
docker-compose up -d

or you can manually run each Dockerfile:
(in server folder)

docker build -t whisper-server .
docker run -d --rm --name whisper-server -p 8000:8000 whisper-server

(in client folder)

docker build -t whisper-client .
docker run -d --rm --name whisper-client -p 3000:3000 whisper-client

You can access the client with http://localhost:3000.
If you want to communicate between multiple clients, change the ws://localhost:8000 to the running server's ip address.
(in client/src/hooks/useSocket.tsx)

Individual Repository

You can check each commit record in individual repository.

• Client: https://github.com/COSE451-2023-2-Team2/whisper-client
• Server: https://github.com/COSE451-2023-2-Team2/whisper-server

Authors

This project is built by team CESCO in COSE451, Korea Univ.