https://github.com/jessety/releasical
ICS calendar feed server for GitHub releases
https://github.com/jessety/releasical
Last synced: 10 months ago
JSON representation
ICS calendar feed server for GitHub releases
- Host: GitHub
- URL: https://github.com/jessety/releasical
- Owner: jessety
- License: mit
- Created: 2023-05-31T04:45:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-17T20:57:47.000Z (over 2 years ago)
- Last Synced: 2025-03-15T21:43:11.267Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 576 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# releasical
> ICS calendar feed server for GitHub releases
Ever wanted your GitHub releases to start showing up in your calendar? Me either, but here we are.
[](https://github.com/jessety/releasical/actions/workflows/ci.yml)
## Setup
First, install dependencies and build the project
```bash
npm install
npm run build
```
Create a `.env` file in the project directory with a GitHub PAT, and optionally a secret key:
```ini
GITHUB_TOKEN=xxx
SECRET=yyy
```
## Usage
Run the service using `npm start`. To start `untappical` as a pm2 service, run `pm2 start ecosystem.config.json`
To see the feed in your calendar application, add a subscription with the following path:
`http://host:port/users/username`
So for example, if the server is running on your local machine on port `8080` and the repository you want to monitor for releases is `jessety/releasical`, you would use the URL:
`http://localhost:8080/jessety/releasical`
If you set a secret key, all requests without it will be ignored:
`http://localhost:8080/jessety/releasical?secret=yyy`