|
|
||
|---|---|---|
| .. | ||
| assets | ||
| src | ||
| vendor | ||
| .gitignore | ||
| build.js | ||
| client.js | ||
| package.json | ||
| README.md | ||
| server.js | ||
osquery website
This website is single page app built on React, with styles and structure taken from the Bootstrap docs website. The app is statically generated to HTML via node and then hosted it by pushing HTML to GitHub Pages.
Installation
If you are working on the site, you will want to install and run a local copy of it.
Dependencies
All dependencies are installed with npm, just:
$ npm install
Instructions
Development
Once you've installed the project's dependencies via npm install, simply start the app:
$ npm start
$ open http://localhost:4000/
This will start an express based node server which will generate static html content and the js bundle on request. After making any modifications the server should restart and regenerate any necessary files on the next request.
Production
This site is statically published on github pages, to do this the static assets need to be generated.
$ npm run build
To test the static files you can use the included express based static file server.
$ npm run start-prod
$ open http://localhost:4000/