Skip to content

Latest commit

 

History

History
139 lines (93 loc) · 4.19 KB

DEPLOYMENT.md

File metadata and controls

139 lines (93 loc) · 4.19 KB
Raw

Deployment

Local Deployment

To run the project locally, install:

For local deployment:

  • Clone this GitHub repository by clicking the green Code button and Download ZIP to download a copy of the project as a zip-file

  • Unzip the file

  • Navigate to the correct file location after unpacking the files

    • cd <path to folder>

  • Create a env.py file with your credentials.

  • Install all requirements from the requirements.txt file using this command:

    • sudo -H pip3 -r requirements.txt

  • Sign up for a free account on MongoDB and create a new Database called vazy_garden. The Collections (tables) in that database should be as follows:

plants

_id: <ObjectId>
category_name: <string>
plant_name: <string>
plant_description: <string>
sow: <string>
is_edible: <string>
is_done: <string>
animal_name: <string>
link: <string>
seed_link: <string>
created_by: <string>

categories

_id: <ObjectId>
category_name: <string>

months

_id: <ObjectId>
sow: <string>

animals

_id: <ObjectId>
animal_name: <string>

users

_id: <ObjectId>
username: <string>
password: <string>
  • Launch the app typing the following command in the terminal:
    • flask run
  • The app should run on localhost on an address similar to http://127.0.0.1:5000. More information here.

Remote Deployment

This site is currently deployed on Heroku using the main branch on GitHub. To implement this project on Heroku, the following steps were taken:

  1. Create a requirements.txt file so Heroku can install the required dependencies to run the app.

    • sudo pip3 freeze --local > requirements.txt

  2. Create a Procfile to tell Heroku that this is a Python app

    • echo web: python app.py > Procfile

    • Make sure there are no blanks lines at the end of the file!

  3. Sign up for a free Heroku account

    • Create a new app

    • Click the Deploy tab

    • Go to Deployment Method section and click Connect GitHub

    • Make sure your GitHub profile is displayed and add the repository name. Once your repository is found, click to connect

    • Once connected, you should see

    • Select Enable Automatic Deploys button

    • After which you should see

  4. Click on Settings tab, then click on Reveal Config Vars.

  • Now we can securely tell Heroku which variables are required by the env.py file. Configure the environmental variables as follows:

    • IP : 0.0.0.0
    • PORT : 5000
    • SECRET_KEY : <your_own_secret_key>
    • MONGO_URI : <link_to_your_MongoDB>
    • MONGO_DBNAME : vazy_garden
    • DEBUG : False

  1. Go back to Deploy tab and navigate to Deploy a GitHub branch. Click Deploy Branch button. Once the app has been built, you can View it.