Social App

Design

Photo&Video-sharing Social Network APP - UI & Architecture Design

Wireframes and Prototypes

• Figma URL

Database

API Documentation

• SwaggerHub

Deploy

Manually

Clone

git clone --recurse-submodules [email protected]:cis557/project-group-x.git
cd project-group-x

Or if you have clone or download this repo, you need to initiate the submodules:

git submodule update --init

Frond End

You can set REACT_APP_API_ENDPOINT environment variable to change the backend API URL. The default value is http://localhost:4000/api.

cd frontend
npm install
npm start

Back End

Sample Configuration:

BACKEND_PORT=4000
DB_URL=
R2_ACCOUNT_ID=
R2_ACCOUNT_KEY=
R2_ACCOUNT_SECRET=
R2_BUCKET_NAME=
R2_PUBLIC_URL=

Save your configuration in the backend/.env file. Then execute:

cd backend
npm install
npm start

Test

Ensure the backend and the frontend are both running, then execute:

npm test

Docker

Install docker first. Save docker-compose.yaml in some place:

version: "3"

services:
  app:
    image: ghcr.io/apocalypsor/toktiksocial
    container_name: toktiksocial
    ports:
      - "80:80"
    environment:
      - DB_URL=
      - R2_ACCOUNT_ID=
      - R2_ACCOUNT_KEY=
      - R2_ACCOUNT_SECRET=
      - R2_BUCKET_NAME=
      - R2_PUBLIC_URL=

Then run:

docker compose up -d