icm/docs
Colin Goutte 9c01fd770b Fix generating documentation 2023-08-23 17:32:09 +02:00
..
Makefile Fix generating documentation 2023-08-23 17:32:09 +02:00
README.rst Fix generating documentation 2023-08-23 17:32:09 +02:00
conf.py Fix generating documentation 2023-08-23 17:32:09 +02:00
index.rst Fix generating documentation 2023-08-23 17:32:09 +02:00
make.bat Fix generating documentation 2023-08-23 17:32:09 +02:00

README.rst

###################################
Documentation the movie API project
###################################

********
Context
********

We want to code a sample api to so show workskills

========
Stack
========

# Fraweworks
I choose to use `FastAPI <https://fastapi.tiangolo.com/>`

Environement / Install
----------------------

We assume make is installed


if pipenv is installed:

.. code-block:: shell

      make clean install run_dev



if pipenv is *not* installed

.. code-block:: shell

    make -f MakefileVenv clean install run_dev



I suggest you have pipenv installed, this projet is writtent under python 3.12 and may work on other versiona
We have a requirement of being virtualenv compatible while i will  working with Pipenv.