64 lines
1.5 KiB
Markdown
64 lines
1.5 KiB
Markdown
# Miller Konsult
|
|
|
|
## Running
|
|
|
|
1. `$ git clone git@gitlab.thecodebureau.com:lohfu/millerkonsult.git && cd millerkonsult`
|
|
2. `$ npm install`
|
|
3. `$ npm run gulp`
|
|
|
|
## Testing
|
|
|
|
`$ npm test`
|
|
|
|
## Admin Panel
|
|
|
|
The admin panel is available under the `/admin` path, ie
|
|
`http://localhost:3000/admin` if you run with the default settings.
|
|
|
|
## Directories
|
|
|
|
### /gulp
|
|
|
|
This contains ALL gulp logic.
|
|
|
|
### /public
|
|
|
|
This directory is maintained by gulp. All static assets get symlinked in here,
|
|
and any built code
|
|
|
|
This folder should not be edited directly, or commited to git.
|
|
|
|
### /sass
|
|
|
|
This folder contains all SASS files and is compiled with the gulp sass task,
|
|
which puts the output CSS into `/public/css`
|
|
|
|
### /server
|
|
|
|
This directory contains all JavaScript that only has to do with running your
|
|
server instance.
|
|
|
|
#### Checking routes
|
|
|
|
```
|
|
console.log(routes):
|
|
```
|
|
|
|
### /static
|
|
|
|
This contains all static content.
|
|
|
|
Most content in here should be symlinked into the public folder. The only
|
|
content in here that needs to be built in production environment should SVG
|
|
files, which should be minified.
|
|
|
|
### /src
|
|
|
|
This contains all JavaScript not only run in the browser. This includes all
|
|
isomorphic code (ie code that runs both in the browser and in the server) and
|
|
browser specific code. All Marko templates, components and custom tags are put
|
|
in here as well. Some of the code in here is only ment to be run in the
|
|
browser, currently this is all the Backbone logic (Backbone views, models,
|
|
collections and routers).
|
|
|