Provide a description of the scope of the project and its goal.
Provide a development server, if applyable.
Provide a staging server, if applyable
Provide API documentation as soon as possible. (ex: swaggerhub.com)
Provide a detailed description of what steps to follow to sucessfully install the application.
$ python --version- Install python on yout local machine, check if instalation was sucessfull.git clone https://github.com/dtx-colab/projetcName.git- Clone the repository to your machine.$ python -m venv venv- Navigate to the project folder and create a virtual enviroment.$ .\venv\Scripts\activate- Activate the enviroment.$ pip install -r requirements.txt- Install all the dependencies of the API project.$ pip install -r .\packages\project_model\requirements.txt- Install all the dependencies of the model package.$ python .\packages\project_model\setup.py sdist bdist_wheel- Package the model so you can use it as a dependency in the API.
Inside medicos-do-mundo folder:
$ set FLASK_APP=run.py- Set the FLASK_APP environment variable. Sintax can very depending on which command line tool you are using.$ flask run- Run the API.
Inside inside the project folder folder:
- Run some tests -
$ pytest .\packages\project_api\tests\
The coding Guidelines are available on the CONTRIBUTING.md file for all those who want to contribute for the development of the project.
- Name Surname, abc.abc@dtx-colab.pt
- Name Surname, abc.abc@dtx-colab.pt
- Name Surname, abc.abc@dtx-colab.pt
- Name Surname, (TM),abc.abc@dtx-colab.pt
- Name Surname, abc.abc@dtx-colab.pt
- Name Surname, (PO), abc.abc@dtx-colab.pt
- Name Surname, abc.abc@dtx-colab.pt
Legend: TL - Team Leader; PO - Product Owner
Provide a link containing more information of the project. For more detailed information see the project's wiki.