An open API service indexing awesome lists of open source software.

https://github.com/openaq/openaq.org

The OpenAQ website
https://github.com/openaq/openaq.org

Last synced: 3 months ago
JSON representation

The OpenAQ website

Awesome Lists containing this project

README

        

# OpenAQ.org website

## Development

The website is built using [Hugo](https://gohugo.io) for content management and static site generation. Netlify Decap is used for a headless CMS.

For styles SCSS is used with the [openaq-design-system](https://github.com/openaq/openaq-design-system) SCSS library. Dart Sass is required to compile SCSS and must be installed and available in PATH for Hugo to access.

To use dart-sass with Hugo, install [dart-sass-embedded](https://github.com/sass/dart-sass-embedded) as follows:

1. Download the binary to match your platform from the releases page: https://github.com/sass/dart-sass-embedded/releases

2. Place the downloaded binary in the desired directory on your system. e.g. ~/bin/sass_embedded

3. Add the path to the binary to your system's PATH:

.zshrc
```
export PATH="${HOME}/bin/sass_embedded:${PATH}"
```

Dart Sass will now be discoverable by Hugo.

## Content Guidance

### Team photos

Team portraits should be uploaded as a squaure image of least at 400px by 400px png. The portrait should include the subjects head and full shoulders down to mid-chest level. After resizing, use [remove.bg](https://remove.bg) to remove the background to create a transparent background around the subject.