README.md

TownSquare

A Social media App to connect with friends.

View Demo*

*_{Note: The backend server is running on a free tier, which means after 20 minutes of inactivity it spins down. So, please be patient, starting from cold the server can take around 20 seconds to start up and respond.}

📔 Table of Contents

• About the Project
  • Tech Stack
  • Features
• Getting Started
  • Prerequisites
  • Installation
  • Run Locally

🌟 About the Project

townsquare.mov

What is TownSquare

TownSquare is a full-stack social media CRUD application. It was built to focus on some key elements of developing social networking apps and APIS, as well as providing a good opportunity to deepen my understanding of developing accessible components such as modals and other such UI features.

It is built using NodeJS on the back-end with MongoDB for the database. The front-end is all built in React with Redux toolkit being used for the state management and RTK Query being using to handle all API requests to the backend. JWT are being used to handle all user authentication on login & signnup.

👾 Tech Stack

Client

• React.js
• TypeScript
• Redux Toolkit & RTK Query
• React Router

Server

• Node JS
• Express.js
• MongoDB

🎯 Features

• Create User account
• Set up your account (add your information, your photos and personality)
• Create posts and share them with your followers
• Search for other users (Follow friends, see and like their posts)

🧰 Getting Started

‼️ Prerequisites

This project was built using Yarn, but you can user either Yarn or NPM to install the server and client side node packages.

⚙️ Installation

Install ./client and ./server with yarn

🏃 Run Locally

Clone the project

  git clone https://github.com/marksist300/TownSquare.git

Go to the client directory

  cd client
  yarn
  yarn  dev

Go to the server directory

  cd server
  yarn
  yarn dev