Skip to content

RudyRed/power_KNAP

 
 

Repository files navigation

fam.ly

Social Video Streaming Application

Power KNAP

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Setting up database
  4. Roadmap
  5. Contributing

Usage

Duplicate the default.env to setup environmental variables and make sure it is added to gitignore!

Notes on environmental variables:

  • DATABASE_URL: postgress://${USERNAME}:${PASSWORD}@localhost:${PORT}/${DATABASE_NAME}
  • LOCAL variable can be 0 (false for production development) or 1 (true for local development)
  • Apply for a Google oAuth key to receive a GOOGLECLIENTID and GOOGLECLIENTSECRET key
    • Upon arriving at the linked site, enable APIs and services and search for Google+ API
    • Create credentials and pass in http://localhost:${PORT} to Authorized JavaScript origins and http://localhost:${PORT}/auth/google/redirect to Authorized redirect URIs
  • Create a random cookie key (really, what ever string you want) for COOKIEKEY; this is for encryption

References:

  • websockets
  • oAuth
  • ReactRouter
    • React-routing changes are not pushed to the master branch
    • Refer to the feat/reactRouter branch for previous work done with react router and ONLY react router (Other features in the feat/reactRouter branch are bugged!)
  • CSS Grids
  • CSS Flex-boxes

Requirements

  • Node 6.4.x
  • npm 5.x.x
  • Postgresql 9.1.x

Development

  • babel-core ^6.26.0
  • babel-loader ^7.1.2
  • babel-preset-es2015 ^6.24.1
  • babel-preset-react ^6.24.1
  • chai ^4.1.2
  • eslint ^4.11.0
  • eslint-config-airbnb ^16.1.0
  • eslint-plugin-import ^2.8.0
  • eslint-plugin-jsx-a11y ^6.0.2
  • eslint-plugin-react ^7.4.0
  • mocha ^4.0.1
  • webpack ^3.8.1

Installing Dependencies

From within the root directory:

npm install

Database

Available GUI:

  • Postgres - Easily start your server with your default database.

  • Postico - Allows users to view created databases and tables. Please create a postico username and password in order to run database locally (you will need both in your .env file - refer to the default.env file).

Roadmap

View the project roadmap here

Refer to our user story based current and desired features on Trello here

Contributing

See CONTRIBUTING.md for contribution guidelines.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 88.2%
  • CSS 7.4%
  • HTML 4.4%