[Feat]: Add heroku configuration for deployment #103

Rahulm2310 · 2021-02-27T17:26:14Z

Description

Add heroku configuration for deployment
Fixes #80

Instructions for deployment :

Login to Heroku
```
heroku login
```
After you have executed the command ‘heroku login’, in the web browser, you are now redirected to the page as shown in the image below. Here, you are required to click on the ‘Log In’ button.
Now, you are required to create an app in Heroku. Hence, for the stated purpose you are required to execute the following command.
```
heroku create open-source-programs-backend
```
After the successful execution of the command you can now view your application in Heroku devcenter.
For deploying your application you are required to execute the following command.
```
git push heroku develop
```
To commit initial migration on the Heroku application you are required to execute the following query.
```
heroku run python manage.py migrate
```
Finally, you can execute the following command to view the hosted website.
```
heroku open
```

Type of Change:

Code
Outreach

Code/Quality Assurance Only

New feature (non-breaking change which adds functionality pre-approved by mentors)

How Has This Been Tested?

Not Applicable

Checklist:

My PR follows the style guidelines of this project
I have performed a self-review of my own code or materials

Code/Quality Assurance Only

My changes generate no new warnings

Rahulm2310 · 2021-02-27T17:26:54Z

@codesankalp @isabelcosta Can you please review this PR. Thanks 🙂

codesankalp · 2021-02-28T06:09:00Z

@Rahulm2310 Will this be able to deploy from the Heroku pipeline through github?

QA checks are also failing.

codesankalp · 2021-02-28T06:11:29Z

main/settings.py

@@ -28,9 +29,9 @@
 SECRET_KEY = "7ibm!g0j@gs7kszwav!6$*lar(+!!l3tpm@09s%csl2bj)l+p4"

 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
+DEBUG = False


For deployment take this DEBUG value from environment variables else for development make this True.

main/settings.py

ProcFile

codesankalp · 2021-03-02T05:51:07Z

@Rahulm2310 Follow the README guidelines for QA-Checks as both workflows are failing.

codesankalp · 2021-03-02T05:55:58Z

main/settings.py

@@ -155,3 +156,9 @@
 # https://docs.djangoproject.com/en/3.0/howto/static-files/

 STATIC_URL = "/static/"
+
+STATIC_ROOT = os.path.join(BASE_DIR, ‘static’)


Please don't include backticks use double-quoted strings.

Rahulm2310 · 2021-03-02T20:10:53Z

@codesankalp Can you please explain why both workflows are still failing?

codesankalp · 2021-03-04T18:45:43Z

@Rahulm2310 Try to follow the commands mentioned in README - https://github.com/anitab-org/open-source-programs-backend#qa-checks
You can also check the suggestion of the workflow.
When QA-Checks will pass I will review this PR.

codesankalp

@Rahulm2310
I tried it on the local system and it is returning 500 server errors for URL which is working.
Please look into that.

Also, You have updated the requirements.txt wrong. Either use the virtual-env to update packages or add dependencies separately. As currently there are 54 dependencies including flask and other stuff which is not needed I think.

codesankalp · 2021-03-07T15:01:57Z

For testing, you can use gunicorn main.wsgi.

Rahulm2310 · 2021-03-08T15:32:22Z

I tried it on the local system and it is returning 500 server errors for URL which is working.

I think that is may be because you don't have DJANGO_DEBUG in your .env file.
Also, I am getting this when running gunicorn main.wsgi.

codesankalp · 2021-03-08T16:23:05Z

@Rahulm2310 I have DJANGO_DEBUG in my .env file. DJANGO_DEBUG=False will be used in production which only means any error will not be shown on the deployed backend.
And I am not sure why gunicorn main.wsgi returns an error in windows because I tried it on Ubuntu. You can research about this error.
But what I wanted is that after running this command it must not show any errors (Server error 500).

Rahulm2310 · 2021-03-08T17:17:32Z

@codesankalp I came to know that gunicorn is for unix environment and is incompatible with windows. There is an open issue on the gunicorn's github repo for this.

codesankalp · 2021-03-08T17:20:34Z

Then @Rahulm2310 there is only one option try deploying on Heroku for testing your code.

Rahulm2310 · 2021-03-08T17:38:33Z

@codesankalp is this the correct way DEBUG = os.environ.get("DJANGO_DEBUG", "") != "False" ?
Also, this works if I remove DJANGO_DEBUG from .env file.

codesankalp · 2021-03-08T18:24:58Z

@Rahulm2310 The line that you have added is correct i.e. it will make DEBUG=False when DJANGO_DEBUG=False will be present in .env file else it will make DEBUG=True in any other remaining condition.

Rahulm2310 · 2021-03-08T18:43:01Z

@codesankalp I tried deploying to heroku. But getting this error when running heroku run python manage.py migrate.
.

Although, I have download file in the project's root still shows this.

codesankalp · 2021-03-09T05:39:00Z

Try to rebase it with the current develop branch then there will be no errors regarding Zulip Key.
The download file is in your local directory but as it is also present in .gitignore because of this it is not present in heroku.

Rahulm2310 · 2021-03-09T08:05:53Z

@codesankalp I rebased with current develop, pushed the download file to heroku and then heroku run python manage.py migrate ran successfully. Here's the deployed link https://open-source-programs-backend.herokuapp.com/api. Could you please check and confirm if it looks alright so that I can push the changes here.

codesankalp · 2021-03-09T08:55:47Z

I tried making a user and it returns a server error.
Maybe you need to set up all environment variables (including sendgrid email) in the .env file.

Rahulm2310 · 2021-03-11T18:50:04Z

Maybe you need to set up all environment variables (including sendgrid email) in the .env file.

I tried adding SENDGRID_API_KEY to heroku config vars(environment variables), still showing the same error. Also, when I tried it locally it gives me this error

Although, my from address is verified sender identity on sendgrid, still getting this error.

codesankalp · 2021-03-12T13:53:26Z

Maybe you need to set up all environment variables (including sendgrid email) in the .env file.

I tried adding SENDGRID_API_KEY to heroku config vars(environment variables), still showing the same error. Also, when I tried it locally it gives me this error

Although, my from address is verified sender identity on sendgrid, still getting this error.

Is it working on local and not working on heroku?

Rahulm2310 · 2021-03-12T17:26:18Z

@codesankalp getting server error when registering a user on heroku.

This is the error when registering a user on local.

codesankalp · 2021-03-12T17:32:59Z

@Rahulm2310 See this for reference: https://sendgrid.com/docs/ui/sending-email/sender-verification/

Rahulm2310 · 2021-03-13T18:39:27Z

@codesankalp I have my sender email verified on sendgrid.

Can I add you as a collaborator to the deployed project on heroku.

codesankalp · 2021-03-13T18:44:11Z

No, It is not needed @Rahulm2310.
If it's a problem related to SendGrid then I will suggest using another email service or consoleBackend.
Let me know if it was able to solve the problem.
Also, Can you access the admin site and was able to create a user from there?

Rahulm2310 · 2021-03-15T17:02:31Z

If it's a problem related to SendGrid then I will suggest using another email service or consoleBackend.

@codesankalp I tried consoleBackend, and I am getting the verification mail in the console.

Seems that this is a problem related to sendgrid.

Also, Can you access the admin site and was able to create a user from there?

yeah I created a super user for heroku app and then created a new user from the admin site.

codesankalp · 2021-03-15T17:40:50Z

@Rahulm2310 In that case I can approve this PR.
I will review it again soon.

devkapilbansal

@Rahulm2310 CI builds are failing. Please look into them.
Also, your branch is not up-to-date with our default branch. Please rebase your branch.
Look into these requests too:- 👇

devkapilbansal · 2021-03-16T11:48:00Z

ProcFile

@@ -0,0 +1 @@
+web: gunicorn main.wsgi


Needs a newline at the end

devkapilbansal · 2021-03-16T11:48:38Z

README.md

@@ -95,8 +95,11 @@ Follow the given instructions for Login into the app.
 	6. Click Create & View.
 	7. The API KEY is generated and displayed to you just once. So be sure to copy and save it somewhere.

+3. `DJANGO_DEBUG` - Set its value to `False` for deployment (not needed for development).


I would rather leave it as DEBUG. Simpler, the better

devkapilbansal · 2021-03-16T11:49:29Z

main/settings.py


-ALLOWED_HOSTS = []
+ALLOWED_HOSTS = ["https://open-source-programs-backend.herokuapp.com"]


No need to add https in allowed host

Suggested change

ALLOWED_HOSTS = ["https://open-source-programs-backend.herokuapp.com"]

ALLOWED_HOSTS = ["open-source-programs-backend.herokuapp.com"]

Better to change the name to anitab-forms-backend

devkapilbansal · 2021-03-16T11:52:59Z

main/settings.py

+STATIC_ROOT = os.path.join(BASE_DIR, ‘static’)
+
+# Activate Django-Heroku.
+django_heroku.settings(locals())


You can try something like this

Suggested change

django_heroku.settings(locals())

from socket import gethostname

HOSTNAME = gethostname()

if HOSTNAME == 'open-source-programs-backend.herokuapp.com':

import django_heroku

django_heroku.settings(locals())

@devkapilbansal Why use this when django_heroku doesn't affect the development environment?

What's the point of setting config if we are using it in development. However, we can ignore this 😕
What's not broken need not to be fixed

codesankalp · 2021-04-03T16:52:22Z

@Rahulm2310 Can you please resolve the merge conflict and do the suggested changes?

Rahulm2310 · 2021-04-03T20:30:30Z

@codesankalp was a bit more involved in OSH. Will apply the suggested changes asap. 🙂

Aaishpra · 2021-04-17T14:28:44Z

Hi, @Rahulm2310 can you do the changes in this, as the deployment of the backend, is one of the high priority things for us currently.

codesankalp · 2021-04-22T18:56:53Z

@Rahulm2310 It is a priority now because the deployed backend is required. Can you please update the PR?

Rahulm2310 · 2021-04-24T08:56:47Z

@codesankalp can you help me identify why CI builds are failing

codesankalp · 2021-04-24T17:58:43Z

@codesankalp can you help me identify why CI builds are failing

Not sure, It is something related to postgres. I think while deleting the database it can't delete it.
I will research about it more.

codesankalp · 2021-05-11T19:35:58Z

download

@@ -0,0 +1,4 @@
+[api]


@Rahulm2310 Remove this file from the commit

codesankalp · 2021-05-11T19:38:37Z

main/settings.py


-ALLOWED_HOSTS = []
+ALLOWED_HOSTS = ["anitab-forms-backend.herokuapp.com"]


@Rahulm2310 I think this is deployed in your Heroku account. So adding it here wouldn't be a nice logic.

added heroku configuration

7ab2319

codesankalp reviewed Feb 28, 2021

View reviewed changes

main/settings.py Outdated Show resolved Hide resolved

codesankalp reviewed Feb 28, 2021

View reviewed changes

main/settings.py Outdated Show resolved Hide resolved

codesankalp added the Status: Needs Review PR needs an additional review or a maintainer's review. label Feb 28, 2021

codesankalp reviewed Feb 28, 2021

View reviewed changes

ProcFile Outdated Show resolved Hide resolved

applied suggested changes

2faa3f7

Rahulm2310 requested a review from codesankalp March 1, 2021 19:36

added newline at end

e3749b2

codesankalp reviewed Mar 2, 2021

View reviewed changes

removed backticks and added double quotes

e6013ad

Rahulm2310 requested a review from codesankalp March 4, 2021 18:25

minor changes

fb09956

codesankalp suggested changes Mar 7, 2021

View reviewed changes

codesankalp added Status: Changes Requested Changes are required to be done by the PR author. and removed Status: Needs Review PR needs an additional review or a maintainer's review. labels Mar 7, 2021

added changes

91fd26b

Rahulm2310 added 3 commits March 9, 2021 13:11

push download file to heroku

6ac2b59

removed procfile

007df04

added procfile

e7089cd

devkapilbansal suggested changes Mar 16, 2021

View reviewed changes

Rahulm2310 added 2 commits April 24, 2021 14:02

applied suggested changes

6acc219

update branch

08c07ee

codesankalp suggested changes May 11, 2021

View reviewed changes


		ALLOWED_HOSTS = []
		ALLOWED_HOSTS = ["https://open-source-programs-backend.herokuapp.com"]

	ALLOWED_HOSTS = ["https://open-source-programs-backend.herokuapp.com"]
	ALLOWED_HOSTS = ["open-source-programs-backend.herokuapp.com"]

-django_heroku.settings(locals())
+from socket import gethostname
+HOSTNAME = gethostname()
+if HOSTNAME == 'open-source-programs-backend.herokuapp.com':
+    import django_heroku
+    django_heroku.settings(locals())


		ALLOWED_HOSTS = []
		ALLOWED_HOSTS = ["anitab-forms-backend.herokuapp.com"]

[Feat]: Add heroku configuration for deployment #103

Are you sure you want to change the base?

[Feat]: Add heroku configuration for deployment #103

Conversation

Rahulm2310 commented Feb 27, 2021

Description

Type of Change:

How Has This Been Tested?

Checklist:

Rahulm2310 commented Feb 27, 2021

codesankalp commented Feb 28, 2021

Choose a reason for hiding this comment

codesankalp commented Mar 2, 2021

Choose a reason for hiding this comment

Rahulm2310 commented Mar 2, 2021

codesankalp commented Mar 4, 2021

codesankalp left a comment

Choose a reason for hiding this comment

codesankalp commented Mar 7, 2021

Rahulm2310 commented Mar 8, 2021

codesankalp commented Mar 8, 2021 • edited Loading

Rahulm2310 commented Mar 8, 2021

codesankalp commented Mar 8, 2021

Rahulm2310 commented Mar 8, 2021 • edited Loading

codesankalp commented Mar 8, 2021

Rahulm2310 commented Mar 8, 2021 • edited Loading

codesankalp commented Mar 9, 2021 • edited Loading

Rahulm2310 commented Mar 9, 2021 • edited Loading

codesankalp commented Mar 9, 2021

Rahulm2310 commented Mar 11, 2021 • edited Loading

codesankalp commented Mar 12, 2021

Rahulm2310 commented Mar 12, 2021

codesankalp commented Mar 12, 2021

Rahulm2310 commented Mar 13, 2021 • edited Loading

codesankalp commented Mar 13, 2021

Rahulm2310 commented Mar 15, 2021 • edited Loading

codesankalp commented Mar 15, 2021

devkapilbansal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devkapilbansal Mar 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devkapilbansal Mar 16, 2021 • edited Loading

Choose a reason for hiding this comment

codesankalp commented Apr 3, 2021

Rahulm2310 commented Apr 3, 2021

Aaishpra commented Apr 17, 2021

codesankalp commented Apr 22, 2021

Rahulm2310 commented Apr 24, 2021

codesankalp commented Apr 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codesankalp commented Mar 8, 2021 •

edited

Loading

Rahulm2310 commented Mar 8, 2021 •

edited

Loading

Rahulm2310 commented Mar 8, 2021 •

edited

Loading

codesankalp commented Mar 9, 2021 •

edited

Loading

Rahulm2310 commented Mar 9, 2021 •

edited

Loading

Rahulm2310 commented Mar 11, 2021 •

edited

Loading

Rahulm2310 commented Mar 13, 2021 •

edited

Loading

Rahulm2310 commented Mar 15, 2021 •

edited

Loading

devkapilbansal Mar 16, 2021 •

edited

Loading

devkapilbansal Mar 16, 2021 •

edited

Loading