TrackMe Ninja
March 23, 2022 ยท View on GitHub
About the application
TrackMeNinja identifies changes on the site you choose and alerts you on them. Don't spend time going through many sites yourself, leave it to TrackMeNinja
Running on your machine
Virtual environment
For better usability, you can install Python virtual environment and work with the application in enclosed env
Install prerequisites
pip install -r requirements.txt
Run the application
python3 main.py
Code Lint
CI/CD pipeline uses github/super-linter for linting the code. More information on super-linter pages
docker pull github/super-linter:latest
docker run -e RUN_LOCAL=true -v ${PWD}:/tmp/lint github/super-linter
Docker
Docker enables you to run application directly without a need to install and configure the environment. Install Docker
# build the image
docker build . -t trackme
# run the application
docker run --rm -it -p 8000:8000/tcp trackme:latest
More documentation on Docker:
- uvicorn Docker image
- Docker image with Uvicorn managed by Gunicorn for high-performance FastAPI web applications
Compose
The web application will be available at http://localhost
To start the containers, use the following command:
docker-compose up
To check if the containers are running, use:
docker-compose ps
To rebuild all the containers, use the following command:
docker-compose up --build
To restart the web service, run:
docker-compose restart web
Logs
To tail logs, run:
docker-compose logs -f web