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

https://github.com/electron/release-status

Public facing release status information
https://github.com/electron/release-status

Last synced: 4 months ago
JSON representation

Public facing release status information

Awesome Lists containing this project

README

        

# releases.electronjs.org

This repository contains code for https://releases.electronjs.org, which provides release status information for
the [Electron](https://github.com/electron/electron) project.

## Getting started

The website is a simple Node.js app built using [Express](https://expressjs.com/) and [Handlebars.js](https://handlebarsjs.com/).

### Installation

To run the app locally, install dependencies and run the `start` script:

```
yarn
yarn start
```

When developing locally, you may want to use the `watch` script instead, which watches for file changes using [nodemon](https://github.com/remy/nodemon).

### GitHub Authentication

The app pulls release information from GitHub, and local usage (especially going through pages of past releases) may hit the rate limit for anonymous GitHub usage. You can provide a GitHub Personal Access Token (PAT) by setting the `GITHUB_TOKEN` environment variable before running the app locally, which will have higher rate limits.

## License

Distributed under the [MIT License](https://github.com/electron/release-status/blob/main/LICENSE).