Skip to content

Latest commit

 

History

History
83 lines (47 loc) · 3.38 KB

install.rst

File metadata and controls

83 lines (47 loc) · 3.38 KB

Development Installation Guide

The following installation guide is oriented towards people interested in running NewsLynx locally on a Mac OS X computer. For deploying the software, please refer to our automation docs.

NewsLynx Core

NOTE - For most applications, we recommend following our automation guide. If you'd like to setup a development environment, following the instructions below for MacOS X. At this time, NewsLynx Core is not supported on Windows.

Install the dependencies

newslynx depends on Postgres and Redis. If you're on Mac OS X, the easiest way to run Postgres is with the Postgres.app. However, if you prefer the Homebrew distribution, make sure to install it with plpython.

$ brew install postgresql --build-from-source --with-python

If you already have the Hombrew version installed, run this command:

$ brew reinstall postgresql --build-from-source --with-python

Finally, install redis via Homebrew

$ brew install redis

If redis does not automatically start, open another tab and run

$ redis-server

Installation

OPTIONAL - First set your configurations. If you don't do this, we will fallback on the app's default configuration file.

Install newslynx, initialize the database, super user, and install default sous chefs, tags, and recipes.

$ git clone https://github.com/newslynx/newslynx-core.git
$ cd newslynx-core
$ make app_install

EXPERT MODE - Don't install the app's default sous chefs, tags, or recipes.

$ git clone https://github.com/newslynx/newslynx-core.git
$ cd newslynx-core
$ make bare_install

For the next steps, refer to the getting started docs.

NewsLynx App

NOTE - For most applications, we recommend following our automation guide. If you'd like to setup a development environment, following the instructions below for MacOS X.

Download the git repository and install dependencies:

$ git clone https://github.com/newslynx/newslynx-app && cd newslynx-app
$ npm install

NewsLynx Desktop

We also have a beta desktop version of NewsLynx App, which brings all of the same functionality of the web interface to a native environment, which can be easier for people to use. You can download the latest release for Mac OS X on the Releases page of the project repo.

Follow that project's issue tracker for progress on the first 1.0 release. If you would like to try it in the mean time please do. If you would like a Windows or Linux version, let us know by filing an issue and we can bake one out.