Skip to content

Commit e2da3ce

Browse files
Hadrienbnaul
authored andcommitted
Updated installation instructions to run cesium_web locally
1 parent b0e4a73 commit e2da3ce

File tree

1 file changed

+23
-31
lines changed

1 file changed

+23
-31
lines changed

README.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Build Status](https://travis-ci.org/cesium-ml/cesium_web.svg?branch=master)](https://travis-ci.org/cesium-ml/cesium_web)
44

5-
## About
5+
## About
66

77
Web frontend for the [`cesium` library](https://github.com/cesium-ml/cesium). Within the browser, users can upload time series data data, extract features, fit a model, and generate predictions for new data.
88

@@ -25,36 +25,26 @@ The easiest way to try the web app is to run it through Docker:
2525
```
2626

2727
## Running the app locally
28-
1. Install the following dependencies:
29-
30-
- supervisor
31-
- nginx
32-
- postgresql (including libpq-dev on Debian)
33-
- npm
34-
35-
### MacOS
36-
Using [Homebrew](http://brew.sh/):
37-
38-
`brew install supervisor nginx postregsql node`
39-
40-
### Linux
41-
On Debian or Ubuntu:
42-
```
43-
sudo apt-get install nginx supervisor postgresql libpq-dev npm nodejs-legacy
44-
```
45-
46-
2. Install Python dependencies: `pip install -r requirements.txt`
47-
3. On Linux, it may be necessary to configure your database permissions: at the end of your `pg_hba.conf` (typically in `/etc/postgresql/9.5/main`), add the following lines:
48-
49-
```
50-
local all postgres peer
51-
local cesium cesium trust
52-
local cesium_test cesium trust
53-
```
54-
and restart `postgresl` (`sudo service postgresql restart`).
55-
56-
4. Initialize the database with `make db_init`
57-
5. Run `make` to start the server and install additional dependencies, and navigate to `localhost:5000`.
28+
1. Install the following dependencies: Supervisor, NGINX, PostgreSQL, Node.JS.
29+
1. On macOS:
30+
1. Using [Homebrew](http://brew.sh/): `brew install supervisor nginx postgresql node`
31+
2. Start the postgresql server:
32+
- to start automatically at login: `brew services start postgresql`
33+
- to start manually: `pg_ctl -D /usr/local/var/postgres start`
34+
2. On Linux:
35+
1. Using `apt-get`: `sudo apt-get install nginx supervisor postgresql libpq-dev npm nodejs-legacy`
36+
2. It may be necessary to configure your database permissions: at the end of your `pg_hba.conf` (typically in `/etc/postgresql/9.5/main`), add the following lines:
37+
38+
```
39+
local all postgres peer
40+
local cesium cesium trust
41+
local cesium_test cesium trust
42+
```
43+
and restart `postgresl` (`sudo service postgresql restart`).
44+
45+
2. Install Python and JavaScript dependencies with `make_dependencies`
46+
3. Initialize the database with `make db_init`
47+
4. Run `make` to start the server and navigate to `localhost:5000`
5848
5949
## Dev Tips
6050
To execute the test suite:
@@ -72,6 +62,8 @@ Debugging:
7262
- Run `make debug` to start webserver in debug mode
7363
- Run `make attach` to attach to output of webserver, e.g. for use with `pdb.set_trace()`
7464
65+
NOTE: Requires Python 3.5 or later.
66+
7567
## Standards
7668
To ensure that JavaScript & JSX code conforms with industry style
7769
recommendations, after adding or modifying any .js or .jsx files, run ESLint with

0 commit comments

Comments
 (0)