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

https://github.com/stackql/stackql.io


https://github.com/stackql/stackql.io

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

[![Netlify Status](https://api.netlify.com/api/v1/badges/ad26d902-9cb1-43be-90d9-284e8c7ac687/deploy-status)](https://app.netlify.com/sites/stackql-io/deploys)

# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```
yarn
```

### Local Development

```
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
export ALGOLIA_API_KEY=""
export ALGOLIA_APP_ID=""
export ALGOLIA_INDEX_NAME=""
export HUBSPOT_ACCT_ID=""
export HUBSPOT_FORM_ID=""
export HUBSPOT_REGION=""
export MAPS_API_KEY=""
export SMARTLOOK_PROJECT_KEY=""
yarn build
```

or PowerShell:

```
$env:ALGOLIA_API_KEY=""
$env:ALGOLIA_APP_ID=""
$env:ALGOLIA_INDEX_NAME=""
$env:HUBSPOT_ACCT_ID=""
$env:HUBSPOT_FORM_ID=""
$env:HUBSPOT_REGION=""
$env:MAPS_API_KEY=""
$env:SMARTLOOK_PROJECT_KEY=""
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

```
$ GIT_USER= USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.