This is the final project of the Full-Stack Web Developer Nanodegree. It should cover and test all topics from the course. I chose to create my own theme for the project and created a few endpoints for a virtual farm. The farm can have animals from a selection of species.

The farm has to autohrization roles, one is the guest and the other is the farm manager. It will be described down below.

Follow instructions to install the latest version of python for your platform in the python docs

We recommend working within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organaized. Instructions for setting up a virual enviornment for your platform can be found in the python docs

Once you have your virtual environment setup and running, install dependencies by naviging to the /backend directory and running:

pip3 install -r requirements.txt

This will install all of the required packages we selected within the requirements.txt file.

• Flask is a lightweight backend microservices framework. Flask is required to handle requests and responses.

• SQLAlchemy is the Python SQL toolkit and ORM we'll use handle the lightweight sqlite database. You'll primarily work in app.py and can reference models.py.

• Flask-CORS is the extension we'll use to handle cross origin requests from our frontend server.

From within the project directory first ensure you are working using your created virtual environment.

All necessary credentials to run the project (including tests) are provided in the setup.sh file. Run the following command to enable the credentials:

source setup.sh

To run the server, execute:

export FLASK_APP=app.py && export FLASK_ENV=development && flask run

On Linux : export

export FLASK_APP=app.py;

On Windows : set

set FLASK_APP=app.py;

Setting the FLASK_ENV variable to development will detect file changes and restart the server automatically.

Setting the FLASK_APP variable to app.py file to find the application.

This file is the schema for the database and has some helper methods to simplyfy the API endpoints in the app.py file

• Tables created: Animal, Species
• Animal table is for storing all animals from the farm (colums: id [integer,primary Key], name [string, mandatory], age [integer, mandatory], comment [string], species_id [integer, ForeignKey to Species])
• Species table is for storing the current species on the farm (columns: id [integer, primary key], name [string, mandatory], description [string], animals [relationship to Animal])

In the following you can find the documentation of the endpoints from this application:

Endpoints GET '/animals' GET '/species' POST '/animals' PATCH '/animals' DELETE '/animals'

GET '/animals'

• Fetches a dictionary of animals from the farm
• Request Arguments: None
• Returns: The dictionary of animals id and name. Also it returns the number of animals and wether it was a success or not

{
    "animals": {
        "1": "Freddy",
        "2": "Shao"
    },
    "number": 2,
    "success": true
}

GET '/species'

• Fetches a dictionary of species from the farm
• Request Arguments: None
• Returns: The number of the different species and a dictionary of species id and name

{
    "number": 4,
    "species": {
        "1": "Dog",
        "2": "Cat",
        "3": "Panda",
        "4": "Guinea Pig"
    },
    "success": true
}

POST '/animals'

• Creates a new animal with the parameters name, age, comment and species id. Name and age are mandatory
• Request Arguments: None
• Request Headers: ---> insert (1. string - name; 2. integer - age; 3. string - comment; 4. integer - species_id)
• Example request JSON

{
	"name": "Spikes",
	"species": "Guinea Pig",
    "age": 4,
    "comment": "Spike likes to run around.",
    "species_id": 4
}

-Returns: Example

{
    "animal_created": "Spikes",
    "created": 3,
    "species": "Guinea Pig",
    "success": true,
    "total_animals": 3
}

DELETE '/animals/int:animal_id'

• Deletes the selected animal
• Request Arguments: animal id

-Returns: Example

{
    "deleted": 3,
    "deleted name": "Spikes",
    "success": true,
    "total_animals": 2
}

Auth0 is used as a third party authentication service. There are two roles for this application.

• Guest: A guest can access all 'GET' endpoints in this application and has the permission 'get:animals'
• Manager: A manager can access all 'GET' endpoints, the 'POST' endpoint, the 'PATCH' endpoint and the 'DELETE' endpoint. He has the permissions 'get:animals', 'post:animals', 'delete:animals'

Login: https://capfarm.herokuapp.com&response_type=token client_id=mKtioZo3JhgPPyeubzW4mm7qI7VdKAl1&redirect_uri=https://capfarm.herokuapp.com

The application is hosted live on Heroku on the following URL:

https://capfarm.herokuapp.com/

To run the tests, run

python test_app.py