Skip to content

Latest commit

 

History

History
85 lines (71 loc) · 4.41 KB

DEPLOYMENT.md

File metadata and controls

85 lines (71 loc) · 4.41 KB
Raw

Deployment

To further develop this project, a copy can be made using the following steps:

ElephantSQL - Database

My database is hosted on ElephantSQL. But you could host your PostgreSQL database wherever. These steps outline the process of the creation of a new database on ElephantSQL.

  1. Login or sign up to ElephantSQL.
  2. Once you have an account click the green Create New Instance button, or click here.
  3. Name your database.
  4. Keep the default plan selected. The Tiny Turtle (Free) plan is adequate.
  5. Click the green Select Region button.
  6. Choose a region local to you.
  7. Click the green Review button.
  8. Confirm the shown details are correct then finish by clicking the green Create Instance button.
  9. From the list of instances select your newly created database.
  10. Make note of the URL - you will need this later.

Cloudinary - Static and Media Files

Static and media files are hosted on Cloudinary, an online host and API provider for all kinds of media adjustments.

  1. Login or sign up to Cloudinary.
  2. Navigated to your Dashboard.
  3. Make note of your API Environment Variable for later.

Copying My Repository

Forking will create a copy of my original repository on your own GitHub account.

  1. Login or sign up to GitHub.
  2. Locate this GitHub repository.
  3. Click the Fork button at the top right of the page.
  4. You will now have a copy on your GitHub account.

GitPod

If you want to edit any of the files I would suggest using Gitpod - a browser based IDE.

  1. Install the Gitpod browser extension.
  2. Locate your copy of the repository.
  3. Click the new green GitPod button above the file list.
  4. Login to Gitpod with your GitHub account.
  5. Requirements will automatically be installed thanks to requirements.txt.
  6. In the terminal window type touch env.py to create your environmental variables file.
  7. Enter the following into the empty env.py file:
import os


os.environ["DATABASE_URL"] = "YOUR ELEPHANTSQL URL FROM EARLIER"
os.environ["SECRET_KEY"] = "A SECRET KEY"
os.environ["CLOUDINARY_URL"] = "YOUR CLOUDINARY URL FROM EARLIER (without the CLOUDINARY_URL= at the start)"
os.environ["EMAIL_USER"] = "A GMAIL EMAIL ADDRESS"
os.environ["EMAIL_PASSWORD"] = "THE EMAIL PASSWORD"
  1. Before you commit any changes back to GitHub remember to create a .gitignore file by typing touch .gitignore into the terminal.
  2. Add env.py to .gitignore.
  3. To set up your database type python manage.py makemigrations in the terminal, then python manage.py migrate.
  4. Type python manage.py createsuperuser into the terminal window and follow the instructions to create your first admin user.
  5. To run the server type python manage.py runserver.

Heroku

Squigl is currently deployed to Heroku. Follow these steps if you want to deploy your copy.

  1. Login or sign up to Heroku.
  2. Once on your Dashboard, click the New and Create New App buttons.
  3. Enter a name for your app and your local region.
  4. Click Create App.
  5. Click Settings.
  6. Click Reveal Config Vars.
  7. Enter the following environmental variables - these are the same as in env.py if you followed the Gitpod steps:
Key Value
DATABASE_URL YOUR ELEPHANTSQL URL FROM EARLIER
SECRET_KEY A SECRET KEY
CLOUDINARY_URL YOUR CLOUDINARY URL FROM EARLIER (without the CLOUDINARY_URL= at the start)
EMAIL_USER A GMAIL EMAIL ADDRESS
EMAIL_PASSWORD THE EMAIL PASSWORD
  1. Click Deploy from the menu.
  2. Click GitHub - Connect to GitHub, and if prompted to login to GitHub.
  3. In the repo-name box type the name of your fork from earlier.
  4. Click Search.
  5. Click Connect next to the correct repository.
  6. Scroll to the bottom and click Deploy Branch.
  7. Pay attention to the log and look out for any errors.
  8. If it was successful your app will now be live.