Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 2.26 KB

README.md

File metadata and controls

51 lines (40 loc) · 2.26 KB
Raw

PictoPass

PictoPass is a simple, symbol-based login system enhancing digital access for the functioning illiterate and non-native speakers. Secure, intuitive, inclusive.

Authors: Zikun Wang (Frontend), Alicja Mahr (Backend), Woo Zhong Han (Frontend), Daniel Oh (Backend)

Getting Started

Prerequisites

Installing

  1. Clone the repo
  2. Copy docker-compose.example.yml to docker-compose.yml
  3. Fill in the environment variables in docker-compose.yml. See Environment Variables for more information.
  4. Start the containers 
    docker-compose up --build -d
  5. Open the app in your browser at http://localhost:80

Environment Variables

Variable Name Description Default Value
DATABASE_URL MongoDB connection string
SALT_ROUNDS Number of salt rounds for password hashing 10
REDIS_USERNAME Redis username
REDIS_PASSWORD Redis password
REDIS_DB Redis database ID
REDIS_URL Redis connection string
JWT_SECRET Secret for JWT signing
ADMIN_KEY Admin key for creating admin accounts
PORT Port for the server to listen on 3000
NODE_ENV Node environment production

Built With