/loki-fundamentals

Tutorial repository for Loki fundamentals

Primary LanguageHTML

Carnivorous Green House

Carnivorous Green House

Description

This project is a simulation of a carnivorous plant greenhouse. The greenhouse is populated with a variety of carnivorous plant. This project is used within the Grafana Loki fundermentals course to showcase log monitoring and alerting.

Features

  • Plant simulation
  • User authentication
  • Bug toggle switch (cause the server to randomly throw errors)
  • Historic plant data
  • Microservices architecture mode

Installation - Local

This project requires python 3.10 to run locally. To install the project, run the following commands:

  1. Clone the repository
git clone https://github.com/Jayclifford345/carnivorous_green_house.git
  1. Install the project dependencies
pip install -r requirements.txt
  1. Run the project
python app.py
  1. Open a web browser and navigate to http://localhost:5000

Installation - Docker

This project can also be run using Docker. To run the project using Docker, run the following commands:

  1. Clone the repository
git clone https://github.com/Jayclifford345/carnivorous_green_house.git
  1. Run using Docker Compose
docker-compose up -d
  1. Open a web browser and navigate to http://localhost:5005

Contributing

If you would like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the original repository.

Please ensure that your code follows the project's coding conventions and includes appropriate tests. Thank you for your contribution!