mirror of
https://github.com/koodiklinikka/koodiklinikka.fi.git
synced 2026-02-08 22:50:36 +00:00
38 lines
1.4 KiB
Markdown
38 lines
1.4 KiB
Markdown
# Koodiklinikka
|
|
|
|
## Getting things up and running
|
|
- Install [Node.js](http://nodejs.org)
|
|
|
|
```
|
|
git clone git@github.com:koodiklinikka/koodiklinikka.fi.git <your project name>
|
|
cd <your project name>
|
|
npm install
|
|
npm start
|
|
open http://localhost:9001 in your browser
|
|
```
|
|
|
|
### Enable LiveReload
|
|
Install [LiveReload for Chrome](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en)
|
|
|
|
## CLI Commands
|
|
* npm install
|
|
* Installs server-side dependencies from NPM and client-side dependencies from Bower
|
|
* npm start
|
|
* Compiles your files, starts watching files for changes, serves static files to port 9001
|
|
* npm run build
|
|
* Builds everything
|
|
|
|
Minification, uglification and other tasks you're expected to run before deploying your product can be made by running the build command with env variable NODE_ENV set to "production"
|
|
```
|
|
NODE_ENV=production npm run build
|
|
```
|
|
## API server
|
|
API proxy can be defined with **SERVER** environment variable.
|
|
```
|
|
SERVER=http://localhost:9000 npm start
|
|
```
|
|
## Development guidelines
|
|
* **public** - directory should be dedicated only to compiled/copied files from **src** - directory.
|
|
It should be possible to delete directory completely and after **npm start** or **npm run build** everything should be as they were before the deletion.
|
|
* All backend dependencies should be installed with **npm**. Browser dependencies should be installed with **bower** or with **npm**.
|