MohamedAlosaili/chatSphere-api

Nodejs(express) API for ChatSphere application

ChatSphere 💬

API Documentation

Description

This repository contains the backend API server for ChatSphere application. For more detailed information about the project, including frontend setup, please refer to the main repository here.

Server Stack

• Nodejs(Expressjs)

• Socket.io

• MongoDB(Mongoose)

• Firebase/storage

• nodemailer

• Json Web Token

Run Server Locally

• First, you should have nodejs, and npm installed

• Second, add the .env file in the root directory with these variables

NODE_ENV=development
PORT=5000

DEV_CLIENT_URL=http://localhost:3000
PROD_CLIENT_URL=

# Get a MongoDB URI from https://cloud.mongodb.com
MONGODB_URI=

EMAIL=
# if you use Gmail you should use the Gmail App Passwords https://myaccount.google.com/apppasswords not the original password
EMAIL_PASSWORD=


# A random string. should match with JWT_SECRET in the fontend
JWT_SECRET=
JWT_EXPIRE=30d

# Firebase config
APIKEY=
AUTHDOMAIN=
PROJECTID=
STORAGEBUCKET=
MESSAGINGSENDERID=
APPID=

MAX_PHOTO_SIZE=1048576
MAX_FILE_SIZE=10485760
MAX_IMAGE_SIZE=10485760
MAX_VIDEO_SIZE=52428800

• Last step, install the dependencies and run the development server:

npm install && npm run dev
# or
yarn install && yarn dev
# or
pnpm install && pnpm dev

• To populate the DB with samples data run the below script

npx ts-node src/seeder i
# or
yarn ts-node src/seeder i
# or
pnpm ts-node src/seeder i