Skip to content
Snippets Groups Projects
Commit 5bde02a4 authored by Kyle Doherty's avatar Kyle Doherty
Browse files

tweaks to developers guide

parent 5f377aad
No related branches found
No related tags found
No related merge requests found
......@@ -15,23 +15,45 @@
3. Leiningen (http://leiningen.org/)
## Build
## devDependencies
Install clojure + npm requirements with
After you've installed the prerequisites and have a local copy of the repo
you'll need to install the following:
lein deps
lein npm
```sh
# install clojure dependencies
$ lein deps
# install frontend dependencies from npm
$ npm install
```
## Frontend overview
To start working, you'll need to build the frontend JS and CSS
We use these technologies for our FE build process to allow us to use modules, es6 syntax,
and css variables.
- webpack
- babel
- cssnext
Build the application JS and CSS with
## NPM scripts & frontend build process
lein webpack
Frontend tasks are managed by NPM. All available tasks can be found in package.json under "scripts".
When developing the frontend client, you'll want to watch for changes,
so run webpack with the '-w' flag.
To build the frontend client without watching for changes, you can use:
./node_modules/webpack/bin/webpack.js -w
```sh
$ npm run build
```
If you're working on the frontend directly, you'll most likely want to reload changes on save, and in the case of React components, do so while maintaining state. To start a build with hot reloading, use:
```sh
$ npm run build-hot
```
Note that changes to CSS variables will only be picked up when webpack is restarted.
Note that at this time if you change CSS variables, those changes will only be picked up when a build is restarted.
## Usage
......@@ -40,7 +62,7 @@ Then run the HTTP server with
lein ring server
## Unit Tests / Linting
## Clojure Unit Tests / Linting
Check that the project can compile successfully with
......@@ -50,7 +72,6 @@ Run the linters with
lein eastwood # Clojure linters
lein bikeshed --max-line-length 240
./lint_js.sh # JavaScript linter
Run unit tests with
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment