Skip to content

Latest commit

 

History

History
107 lines (96 loc) · 2.66 KB

README.md

File metadata and controls

107 lines (96 loc) · 2.66 KB
Raw

Chat Web Application

Screen Capture

Demo Video Link

Overview

This project is a full-stack web application with a Golang backend, a React TypeScript frontend, PostgreSQL for data storage, and Redis for upvote/downvote functionality.

Frontend Framework: React Typescript

  • User authentication
  • Real-time messaging
  • Upvote/downvote functionality
  • Responsive chat interface

Backend Framework: Go

  • RESTful API for fetching historical message data
  • Websockets for real-time messaging
  • User authentication
  • Vote handling with Redis

Protocol

  • RESTful API: Used for fetching historical data and user authentication.
  • Websockets: Used for real-time messaging and vote updates.

Storage

  • PostgreSQL: Used for storing usernames, passwords, and messages.
  • Redis: Used for handling upvote and downvote counters.

Project Structure

Nimble-FullStack/
│
├── golang/
│   ├── Dockerfile.backend
│   ├── go.mod
│   ├── go.sum
│   ├── server.go
│   ├── .env
│   └── ... other directories and files
│   
├── react-typescript/
│   ├── Dockerfile.frontend
│   ├── package.json
│   ├── package-lock.json
│   └── src/
│       ├── index.tsx
│       └── ... other files
│
├── postgres-init/
│   └── init.sql
│
├── Dockerfile.postgres
└── docker-compose.yml

Build and Start the Services

docker-compose up --build

This command will build the Docker images and start the containers for the backend, frontend, PostgreSQL, and Redis.

Running the Application

You can access your application at:

I follow these steps to test my backend, db and frontend setup using Docker.

Test and run DB locally

First, set up redis and postgres using docker commands:

docker-compose up -d postgres
docker-compose up -d redis

Test PostgreSQL and Redis

docker exec -it $(docker ps -qf "name=postgres") psql -U postgres -d nimble_chat
docker exec -it $(docker ps -qf "name=redis") redis-cli

Inside the PostgreSQL shell:

\dt
SELECT * FROM user;

Test and run backend locally

Navigate to the backend golang directory:

go run server.go

Test backend docker image:

docker-compose up -d backend

Test and run frontend locally

Navigate to the frontend react-typescript directory:

npm start

Test frontend docker image:

docker-compose up -d frontend