Vets

Welcome to the documentation for fluffy-octo-telegram (or the "Vets" application).

For what it is, head over to the Architecture section which details what the application "looks like" and its core functionality. It is also where the design wireframes, mockups etc. are.

Running the project

There are a couple of ways to run the project, the suitability of each is dependent on individuals current dev setups etc.

Method 1: Quick and dirty - using python and poetry

If you already have python and poetry installed you can just clone the repo, migrate the database and start the application:

# Set some env vars for running app locally.
export DJANGO_CACHE=local
export DJANGO_SECRET_KEY=some_long_random_string_0123456789
export DJANGO_DATABASE=local
export DJANGO_DEBUG=True

# Clone repo and cd into dir. 
git clone https://github.com/w3s7y/fluffy-octo-telegram.git
cd fluffy-octo-telegram

# Install python dependencies, migrate db and run local server (http://localhost:8000/vets/admin). 
poetry install
poetry run vets-app-manage migrate
poetry run vets-app-manage createsuperuser
poetry run vets-app-manage runserver

Method 2: Complete development setup

If you don't already have a development environment for python you will probably want to setup a new one with all the bells and whistles, head over to the Development section to get setup.

The kanban board

The project in-flight status, milestones etc. are all over on github projects: here

Links

note: only work if you have setup the local k8s environment