Skip to content
This repository has been archived by the owner on Dec 11, 2020. It is now read-only.
/ getting-started Public archive

Installer and auto updater for the PCT environment

License

Notifications You must be signed in to change notification settings

pct-org/getting-started

Repository files navigation

Project moved to popcorn-env

logo
Getting Started


Getting started

This repo helps you to get an easier experience setting up this environment. If you want to develop on one specific project please so the README of one of those projects.

Projects

Popcorn Time consists of several projects, each doing its own part.

Project Description
@pct-org/getting-started Explains how to get started with this setup
@pct-org/graphql-api Serves the data to the clients from the MongoDB database
@pct-org/scraper Scrapes everything and saves it to MongoDB database
@pct-org/mongo-models Models used for MongoDB and GraphQL object types
@pct-org/native-app React Native App
@pct-org/updater Updater that automatically updates the projects

Installation

Platforms

There is a installation scripts available to help install everything you need to run on a certain platform, scripts that are available:

Click on the links to ge more info on how to run on those platforms.

Manual installation

Requirements

  • Make sure MongoDB is running, for Mac users there is a docker-compose file.
  • If you want transcoding support make sure you have ffmpeg installed
# Clone this repository
$ git clone --recurse-submodules https://github.com/pct-org/getting-started.git

# Install dependencies
$ yarn install

# Run the setup command
$ yarn setup

Last step is to copy the ecosystem.config.example.js to ecosystem.config.js file and fill it in.

Starting the project (PM2)

# To start the APIs (Scraper will immediately start scraping)
$ yarn start

# To stop the APIs
$ yarn stop

# To delete the PM2 apps
$ yarn delete

Contributing:

Please see the contributing guide.

Issues

File a bug against pct-org/getting-started prefixed with [getting-started].

This project is MIT licensed.

About

Installer and auto updater for the PCT environment

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published