diff --git a/.gitignore b/.gitignore index 36b13f1..d8dd662 100644 --- a/.gitignore +++ b/.gitignore @@ -174,3 +174,6 @@ cython_debug/ # PyPI configuration file .pypirc +# MacOS annoying file +.DS_Store + diff --git a/README.md b/README.md index 14c9dc2..a5813fe 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,14 @@ This repository needs to be used as a template for all microservices that we are ## Folder structure: +``` microservice_name/ │ ├── main.py # Entry point for your FastAPI application │ ├── requirements.txt # Python dependencies ├── Dockerfile.txt # Docker containerfile -├── README.md # Project documentation +├── README.md # Project documentation ├── .gitignore # Define what to ignore during version control │ ├── app/ # Application directory @@ -68,6 +69,7 @@ microservice_name/ │ ├── test_endpoints.py │ └── test_models.py └── ... +``` ### Some explainig: