Skip to content
This repository has been archived by the owner on May 23, 2021. It is now read-only.

Latest commit

 

History

History
75 lines (49 loc) · 1.87 KB

README.md

File metadata and controls

75 lines (49 loc) · 1.87 KB

Lunch (AKA Server)


Structure

Codebase/Folder Description
index The main file for the server (TS). This is ran when you run the server
utils The main folder for the server, houses the utils or users and utils files
router The folder for the router/showing the server is runing

How to Run

Make Oauth App

First you need to make a github Oauth app See here

These fields should be filled out like this:

Example

Fill in .env

Now rename the .env.example to .env and fill out the feelds

Example:

URL=Your Mongo DB URL
ID=Your Client ID (Github)
SECRET=Your Client SECRET (Github) 

Install all node moduales (Only one time, do it when you pull too)

Type the following into the command line:

$ yarn install

Make js files

Type the following into the command line:

$ yarn build

Run the server

Type the following into the command line:

$ yarn start

About

This is the server folder for the chat app. It gest all requests from the client side.

Modules Used
Socket.io
express
http

Socket.io

https://socket.io/

This is a module to send and receve request faster than HTTP requests

Express

https://expressjs.com/

This module helps make a server on a port.