Skip to content

jstephensii/diversityonscreen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Diversity on Screen

Tracking diversity in the media. From movies to television shows with the intent of delivering multiple cross-platform tools.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Server: you'll need to setup NodeJS on GoogleAppengine.

[NodeJS on GoogleAppengine]https://cloud.google.com/nodejs/docs/setup
> Make sure to install [YARN]https://yarnpkg.com/en/docs/install

Client: React + ES6 setup with create-react-app

Installing

Server

  1. Setup NodeJS on GoogleAppengine development environment. Make sure to install YARN
  2. Clone repo
  3. Get dependencies yarn install
  4. Start server yarn start

Client

  1. Install dependencies for the Client
  cd client/ && yarn install
  1. Start webpack-dev-server
  yarn start
  • API calls directed to webpack-dev-server are redirected to dev-server(above) at port :3000.
  1. Site should be live at Localhost

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

  1. Use gcloud to deploy. gcloud app deploy

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc