README.md

WaveChat

A Real Time Social Media Platform

Table of Contents

1. About The Project
   • Project Preview
   • Built With
2. Getting Started
   • Prerequisites
   • Clone the repository
3. Usage
   • Run in production mode
   • Run in development mode
   • Initialize AWS S3 bucket
   • Browse the app
4. License
5. Contact

About The Project

WaveChat is a real time social media application made for college/university students. In the recent couple years, the covid-19 pandemic has changed how students of all level interact with each other. It has been really tough for students to meet new people and make friends over the internet. This app was made for students to find other students of similar interest and make new friends. It also makes it easy for students of a certain course or section to communicate with each other about their activities and help each other.

Preview

Built With

TypeScript	NextJs	ReactJs	Apollo	Tailwind CSS	GraphQL	Pothos
Socket	NodeJs	Prisma	PostgreSQL	Redis	Docker	AWS S3

Getting Started

Prerequisites

• Node.js
• Pnpm
• Docker
• Docker Compose
• Git
• AWS-CLI

Clone the repository

git clone https://github.com/FourLineCode/wavechat.git

Usage

Run in production mode

pnpm deploy

Make sure to install dependencies with pnpm install command before deploy.

Run in development mode

pnpm dev

Make sure to install dependencies with pnpm install command before development.
Development runs docker containers in the background. Run pnpm dc:down to stop the containers.

Initialize AWS S3 bucket

awslocal --endpoint-url=http://localhost:4566 s3 mb s3://wc-media
awslocal --endpoint-url=http://localhost:4566 s3api put-bucket-acl --bucket wc-media --acl public-read

This is only applicable to local development.
Use the actual AWS cli or web control panel to initialize AWS S3 bucket in production.

Browse the app

• Frontend - http://localhost:3000
• GraphQL Playground - http://localhost:5000/graphql

License

Published and distributed under the MIT License. See LICENSE for more information.

Contact

Email - akmal3535.ah@gmail.com
Twitter - @FourLineCode
Facebook - Akmal Hossain