Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pradel/octon
Notifies you when a new release has been made on repositories you starred on Github or Docker.
https://github.com/pradel/octon
apollo github graphcool graphql javascript react
Last synced: 4 months ago
JSON representation
Notifies you when a new release has been made on repositories you starred on Github or Docker.
- Host: GitHub
- URL: https://github.com/pradel/octon
- Owner: pradel
- License: mit
- Created: 2016-10-09T16:14:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-07T14:00:20.000Z (over 7 years ago)
- Last Synced: 2024-06-12T01:46:10.603Z (8 months ago)
- Topics: apollo, github, graphcool, graphql, javascript, react
- Language: JavaScript
- Homepage: https://octon.now.sh/
- Size: 773 KB
- Stars: 9
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# octon
[](https://travis-ci.org/pradel/octon)
[](https://github.com/prettier/prettier)
Notifies you when a new release has been made on repositories you starred on Github.
## Features
Emails you when a new release has been made on Github.
- Daily mail
- Weekly mail
- Github support
- TODO: Docker support
## Stack
- [Next.js](https://github.com/zeit/next.js)
- [React](https://facebook.github.io/react)
- [Apollo](http://www.apollostack.com) - Graphql client
- [styled components](https://www.styled-components.com/) - Styling
- [Graphcool](https://www.graph.cool) - Graphql backend
- [Auth0](http://auth0.com/) - Auth
## Contribute
Pull requests are always welcome!
In order to run the project you will need to setup [Graphcool](https://www.graph.cool/) and [Auth0](http://auth0.com/).
#### Graphcool setup
You need to apply the following schema to your graphcool project.
```graphql
type User implements Node {
id: ID! @isUnique
auth0UserId: String @isUnique
email: String! @isUnique
username: String!
avatar: String!
lastGithubSyncAt: DateTime
dailyNotification: Boolean! @defaultValue(value: true)
weeklyNotification: Boolean! @defaultValue(value: true)
repositories: [Repository!]! @relation(name: "UserRepositories")
createdAt: DateTime!
updatedAt: DateTime!
}
type Repository implements Node {
id: ID! @isUnique
name: String!
avatar: String!
htmlUrl: String!
type: String!
refId: String!
users: [User!]! @relation(name: "UserRepositories")
releases: [Release!]! @relation(name: "RepositoryReleases")
createdAt: DateTime!
updatedAt: DateTime!
}
type Release implements Node {
id: ID! @isUnique
tagName: String!
htmlUrl: String!
type: String!
publishedAt: DateTime!
refId: String!
repository: Repository! @relation(name: "RepositoryReleases")
createdAt: DateTime!
updatedAt: DateTime!
}
```
#### Auth0 setup
[Connect your app to github](https://auth0.com/docs/connections/social/github).
#### App setup
1. `cp .env.default .env` Edit the .env file
2. `yarn` Install nodejs dependencies
3. `yarn dev` Start the app in dev mode
Before submitting a pull request, please verify that your branch pass the tests with command `yarn test`.
Special thanks to [Quentin Saubadu](https://www.facebook.com/quentinsaubadu) for the logo and design!
## License
MIT © [Léo Pradel](https://github.com/pradel)