README.org

CS554 Final Project: Client Connect

Group Members

• Khayyam Saleem, Michael Iacona, Maxwell Melo, Annie Topoleski

Demo Video

Getting Started

Setup

With Docker (easy)

• Ensure you have docker installed:
  • macOS: brew cask install docker, then run Docker.app from Applications folder
  • Linux:

    curl -fsSL https://get.docker.com/ | sh
    sudo usermod -aG docker $USER
    sudo systemctl start docker
            

  • Windows: Find a tutorial somewhere…
• Clone the repository:

  git clone https://github.com/khayyamsaleem/cs554-final-proj
  cd cs554-final-proj
      

• Create a .env file. For non-prod environments, you can just rename .env.sample to .env to get started.
• In .env, change MONGO_URL_TEST to “mongodb://mongo:27017/clientconnect”
• Run

  git checkout -b feature/<feature-name> # e.g feature/chat-client
  docker-compose up --build
      

Without Docker (annoying)

• Clone the repository as above.
• Create a .env file. For non-prod environments, you can just rename .env.sample to .env to get started.
• Ensure that you have yarn, nodemon, redis-server, and mongod installed on your machine.
• In a separate terminal, start a mongo server (mongod)
• In a separate terminal, start a redis server (redis-server)
• In a separate terminal, run these commands:

  git checkout -b feature/<feature-name> # e.g. feature/chat-client
  yarn install
  yarn dev:start
      

Contributing

• Take a look at the contribution tutorial.

Stack

• mongo, express, react (Next.js), node (MERN)
• socket.io for messaging
• redis for chat caching
• mongoose for schema definition
• Semantic UI for rendering
• winston for logging