Skip to content
BastianLoPublic

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Repository files navigation

Project logo

Fermento

Status GitHub Issues GitHub Pull Requests License CI Pipeline


Fermento is a self-hostable recipe manager specifically for fermentation.

📝 Table of Contents

🧐 Features

WIP: Project is still in development and not feature complete!

  • Manage your fermentation recipes
  • Create recipe variations (e.g if you are having multiple Kombuchas with the same Base) (TODO)
  • Create reoccuring tasks
    • Each recipes can contain reoccuring tasks which have to be done overtime
    • Never again forget to feed your sourdough

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installing

A step by step series of examples that tell you how to get a development env running.

First clone this repository

git clone https://github.com/BastianLo/Fermento

Then install the required dependencies

pip install -r Fermento/requirements.txt

After successfully installing the dependencies, apply the django database migrations

Fermento/Fermento/manage.py migrate

The Application is now correctly installed and can be run

python3 Fermento/Fermento/manage.py runserver

🔧 Running the tests

WIP

🎈 Usage

WIP

🚀 Deployment

Docker

Fermento can easily be deployed using docker.

version: '3.3'
services:
    fermento:
        container_name: fermento
        environment:
            - LISTEN_PORT=6733
            - USERNAME=${USERNAME}
            - PASSWORD=${PASSWORD}
            - EMAIL=${EMAIL}
            - DEBUG=False
            - APP_DOMAIN=http://127.0.0.1:6733
        ports:
            - '6733:6733'
        image: 'bastianlo/fermento:latest'
        volumes:
            - ./data:/Fermento/Fermento/data

⛏️ Built Using

✍️ Authors

See also the list of contributors who participated in this project.

🎉 Acknowledgements

This project is using icons from flaticon.com

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages