Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.33 KB

README.md

File metadata and controls

75 lines (49 loc) · 2.33 KB

Air Guard Website

Build and Deploy Github Pages

Source of the gaisasargs.lv website hosted on Github Pages and built using the Jekyll static site generator.

For the hardware and software, checkout the github.com/open-lv/air-guard repository.

Contribute

Please open an issue to report a problem with the website or suggest an addition. Alternatively, open a pull request with the suggested changes.

Development Environment

The repository includes a Docker environment that includes all the necessary tooling. Alternatively, you can install and run the tooling locally.

Using Docker Compose

  • Install Docker Compose.
  • Run docker-compose up from project root directory to start the development environment in the "watch" mode that automatically detects all the changes to the source files and builds the site.
  • Open http://localhost:4000 to access the local development site.

Using Local Tooling

This should be used only if you're not able to run the Docker environment locally.

Start the Jekyll webserver

  • Open terminal and go to /docs folder and install required gems:

    cd ./docs
    bundle install
  • Run server:

    cd ./docs
    bundle exec jekyll serve

Run the CSS and JS build tools

  • Open terminal and go to /ui folder and install required packages

    cd ./ui
    yarn install
  • Compile UI sources and watch for changes:

    cd ./ui
    yarn run watch
  • Compile UI sources:

    cd ./ui
    yarn run build

Credits

See the contributors.