Skip to content

README.md

Latest commit

 

History

History
37 lines (27 loc) · 1.49 KB

README.md

File metadata and controls

37 lines (27 loc) · 1.49 KB
Raw

Netlify Status

Chatify

Link to FrontEnd

Link to backend

What is it?

  • Chatify is a free community chat application built after a model of Slack.

Motivation?

  • Recreate a known application in a stack not taught by Lambda.
  • Provide users a fun way to communicate with each other.
  • Practice creating a mid level project from the ground up.

How to install and Run?

Chatify requires you to create your own environmental files and variables to run.

  • Fork and clone this repository
  • Run the command yarn install to install all required dependencies.
  • Run knex migrate:latest to roll all migrations.
  • In the root of the project add a .env file with the following variables.
    • SECRETORKEY=[STRING]
      • This will be a passport secret key generated by you
    • jwtSECRET=[STRING]
      • This will be a jsonwebtoken secret string generated by you
    • MONGODB_URI=[STRING]
      • MONGODB_URI defaults to mongodb://localhost:27017/[name of cluster]
    • HOST=[SERVER URI]
  • In the react client root add a .env.development file with the following variable.
    • REACT_APP_SERVER_URL=[http://localhost:9000] this will need to be changed to your server URL on deployement
  • run yarn dev
  • The site will compile both server side and client side and open in your browser.