Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ivanch/notificc

Log when some website changes.
https://github.com/ivanch/notificc

change-detection checker docker docker-image

Last synced: 6 days ago
JSON representation

Log when some website changes.

Awesome Lists containing this project

README

        


NotificC - Get notified when a website changes




Codacy grade
LGTM Alerts

## Features
* Auth Page
* Push Notifications (allows multiple devices)
* Website change logs

## Deploy (Docker)
```shell
docker run --name notificc -d \
-m 150m \
-p 8800:80 \
-v $PWD/data:/api/shared \
ivanch/notificc:latest
```

With SSL:
```shell
docker run --name notificc -d \
-m 150m \
-p 8800:80 \
-v $PWD/data:/api/shared \
-v /path/to/certs:/etc/nginx/certs \
--env SSL_CERT=example.com.crt \
--env SSL_KEY=example.com.key \
ivanch/notificc:latest
```

## Build Docker Image
**You'll have to build the image again if you don't want to use default http://example.domain as the service URL.**
1. Clone this repo with `git clone https://github.com/ivanch/notificc`
2. Run `docker build -t ivanch/notificc:latest --build-arg PUBLIC_URL=http://DOMAIN/PATH .`
3. [Deploy](#deploy-docker)

## Usage
Default password is *password*, you can change or disable that later in Settings.

Once at the index page, you can start/stop the checker by clicking at its status badge.

## Screenshot

![Index page](assets/index.png)

## Development
1. Run `pip install -r api/requirements.txt` to install all the requirements.
2. Go to `web` folder, run `npm install` to install dependencies and `npm start` to start the development server.
3. Go to `api` folder and run `python app.py` to start the API server.