Skip to content

Latest commit

 

History

History
92 lines (49 loc) · 2.64 KB

running-the-api-and-app.rst

File metadata and controls

92 lines (49 loc) · 2.64 KB

Running the API and Application

Running Newslynx Core

Once you've installed and initialized NewsLynx Core, you can start a debug server with the following command:

$ newslynx debug

If you'd like to start a multi-theaded production server (some Sous Chefs may not work without this), run this command inside the root directory of newslynx-core:

$ bin/run

To start the task queue, run this command inside the root directory of newslynx-core:

$ bin/start_workers

To stop the task queue, run this command inside the root directory of newslynx-core:

$ bin/stop_workers

To start the Recipe scheduler, run this command:

$ newslynx cron

Running NewsLynx App

To start the server, in the newslynx-app folder, run the following:

$ npm start

This compiles your CSS and JS and runs the server with Forever.

When you see the following, it's done and you can visit http://localhost:3000.

Note: If you are running this in production, you want to run it in behind https and tell the app you are doing so one of two ways:

  1. Run it with the environment variable NEWSLYNX_ENV=https
  2. Set https: true in your ~/.newslynx/config.yaml file

This will make sure your cookies are set securely.

#####################################
# HTTP listening on 0.0.0.0:3000... #
#####################################

Other App start up commands

Alternate commands are in package.json under "scripts". These are for developing locally.

If you want to modify files and have the CSS and JS re-compiled automatically and the server restarted if necessary, do:

$ npm run dev

If you just want to watch the CSS and JS and re-compile when on change, do:

$ npm run watch-files

If you just want to watch the Express server and restart when its files change (templates, server js files), do:

$ npm run watch-server

These last two commands are best run in tandem in two separate shell windows. npm run dev does them both in one window for convenience.

The final command listed is npm test, which will run a simple test to make sure the server can launch.