https://github.com/dopry/pecans
:chestnut: Releases/downloads server with auto-updater and GitHub as a backend
https://github.com/dopry/pecans
electron github-releases squirrel
Last synced: 12 months ago
JSON representation
:chestnut: Releases/downloads server with auto-updater and GitHub as a backend
- Host: GitHub
- URL: https://github.com/dopry/pecans
- Owner: dopry
- License: apache-2.0
- Created: 2021-05-23T02:01:40.000Z (almost 5 years ago)
- Default Branch: next
- Last Pushed: 2023-09-13T21:36:00.000Z (over 2 years ago)
- Last Synced: 2025-04-07T21:42:12.367Z (about 1 year ago)
- Topics: electron, github-releases, squirrel
- Language: TypeScript
- Homepage:
- Size: 821 KB
- Stars: 8
- Watchers: 1
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Pecans
Pecans is an Electron Release Server.
## Features
- Download URLS
- `/download/latest`
- `/download/latest/:os`
- `/download/:version`
- `/download/:version/:os`
- `/download/channel/:channel`
- `/download/channel/:channel/:os`
- Auto-updates with [Squirrel](https://github.com/Squirrel)
- For Mac using Squirrel.Mac `/update?version=&platform=osx`
- `/update/:platform/:version`
`/update/channel/:channel/:platform/:version`
- For Windows using Squirrel.Windows and Nugets packages
- `/update/:platform/:version/RELEASES`
- `/update/channel/:channel/:platform/:version/RELEASES`
- GitHub Release Integration
- GitHub Private Repository Hosted Releases
- GitHub Release Webhook to keep releases up-to-date.
- Release Channels (`beta`, `alpha`, ...)
- Express App (composable)
- Release Noted API, `/notes/:version`
- Atom/RSS feeds for versions/channels
## Deploy it / Start it
[Follow our guide to deploy Pecans](https://pecans.darrelopry.com/v/main/docs/deploy).
## Auto-updater / Squirrel
This server provides an endpoint for [Squirrel auto-updater](https://github.com/atom/electron/blob/master/docs/api/auto-updater.md), it supports both [OS X](https://pecans.darrelopry.com/v/main/docs/update-osx) and [Windows](https://pecans.darrelopry.com/v/main/docs/update-windows).
## Documentation
[Check out the documentation](https://pecans.darrelopry.com/v/main/docs) for more details.
## Acknowledgements
- forked from [Nuts](https://github.com/GitbookIO/nuts).