Skip to content

Commit

Permalink
Update getting started section for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
mattbdean authored Oct 31, 2017
1 parent d3fe4db commit 2b2ad22
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,36 @@ Create the file `db.conf.json` in the project root:
"prod": {
"user": "<database username>",
"password": "<database password>",
"database": "<database name>",
"database": "<schema name>",
"host": "<database hostname>"
}
}
```

The database user should have access to read and insert data on the given database.
> The database user should have access to read and insert data on the given database.
Set `NODE_ENV=prod` and use the `prod` script for a production build, which enables uglifying JS and AOT compilation. You can also specify `PORT=<whatever>` to change the HTTP port. If you want to run Helium on the default HTTP port (80), you'll have to run it as root. Port 3000 is used by default.
Run the website on [localhost:3000](http://localhost:3000):

```sh
$ PORT=3001 NODE_ENV=prod yarn prod
$ yarn prod
```

Once the website is built, you can re-run it with

```sh
$ node dist
```

Change the port like this:

```sh
$ PORT=3001 yarn prod
```

Now you can access the website at [localhost:3001](http://localhost:3001).

> If you want to run Helium on the default HTTP port (80), you'll have to run it as root.
## Contributing

Helium runs on a TypeScript-based MEAN stack (but with MySQL instead of MongoDB) and is tested with Mocha, Chai, Karma, and Protractor.
Expand Down

0 comments on commit 2b2ad22

Please sign in to comment.