silkkycloud / silkky.cloud

Protect your information and anonymity against global surveillance.

Contributing

Important: Please sign your commits with GPG. Guide

1. Fork this repository

2. Clone your fork

3. Create a new branch for your new feature

• git branch feature
• git checkout feature

4. Install dependencies and build static site

• yarn install
• yarn build

Setup development server

1. Install dependencies

• yarn install

2. Build static site

• yarn build

3. Start development server

• yarn start

4. Go to http://localhost:8080/

Using build scripts

To build the static site we use NPM / yarn scripts, for convenience each build is seperated into separate scripts.

Full build:

• yarn build

Compile the Liquid files

• yarn html

Compile the SASS / SCSS

• yarn css

Static files (Copies files from 'node_modules' and 'public')

• yarn static

Thanks to JetBrains for supporting this project by providing free licenses for their development tools.