mirror of
https://github.com/valitydev/osquery-1.git
synced 2024-11-08 10:23:54 +00:00
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
# osquery website
|
|
|
|
This website is single page app built on [React](http://facebook.github.io/react/), with styles and structure taken from the [Bootstrap](http://getbootstrap.com/) docs website.
|
|
The app is statically generated to HTML via node and then hosted it by pushing HTML to [GitHub Pages](http://pages.github.com/).
|
|
|
|
## 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:
|
|
|
|
```sh
|
|
$ npm install
|
|
```
|
|
|
|
### Instructions
|
|
|
|
#### Development
|
|
|
|
Once you've installed the project's dependencies via `npm install`, simply start the app:
|
|
|
|
```sh
|
|
$ 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 HTML needs to be generated.
|
|
|
|
```sh
|
|
$ npm start
|
|
$ cd /tmp
|
|
$ wget -r localhost:4000
|
|
$ cd ~/git/osquery # or where ever you have osquery checked out
|
|
$ git checkout gh-pages
|
|
$ mv /tmp/localhost:4000/* ./
|
|
$ git commit -am "site updates"
|
|
$ git push origin gh-pages
|
|
```
|