#A02 - As admin, I would like to create new hackathon events #99

hebs87 · 2020-10-23T20:26:04Z

User Story ID:

#A02 ( As admin, I would like to create new hackathon events)
Feature

Description of PR:

All changes made are outlined below:

Added 'theme' field to Hackathon model to enable setting a theme when creating an event.
Added blank=True, null=True attributes to required Hackathon model fields to ensure they are required in the form.
Created HackathonForm ModelForm to enable rendering form with relevant fields in the frontend, and to enable basic form validation.
Created form template - create-events.html
Added datetimepicker to form template for start_date and end_date fields to enable selecting both date and time in same field.
Added the following properties to the datetimepicker (can be amended if needed):
- Time step set to 30 mins.
- Min and default start date set to tomorrow's date.
- Min and default end date set to day after tomorrow's date.
- Min selectable time is 8am and max selectable time is 6pm.
- Week starts on Monday.
- Year starts on current year (unable to select earlier year).
Created create_event view to render HTML template, and with following logic:
- GET - checks if user is admin, redirects to hackathon list page if not.
- POST - Ensures start date is tomorrow or later and that end date is at least 1 day after start date:
  - If not, display relevant error message and re-render form.
  - If yes, submit form and redirect to hackathon list.
  - If all checks pass, form is submitted and user is redirected to the hackathons list page with the newly added event visible.
Added 'Create Event' link to 'Hackathons' nav menu dropdown in base.html, only for admin users
Added 'Create' button to hackathon list page - hackathon_list.html - only for admin users

Tests:

Manually tested all implemented functionality, which is all working as expected.
Validated all code in relevant validators and all passed - HTML validator threw errors for Django template tags, but no other errors.

Know bugs/errors:

No know bugs or errors after testing.

Screenshots:

Does this introduce a breaking change

Yes
[] No

# Conflicts: # .gitignore

…ned directories to .gitignore

…tes to required fields

…rations

… added TODOs

# Conflicts: # .gitignore # hackathon/urls.py # hackathon/views.py

# Conflicts: # templates/base.html

# Conflicts: # .gitignore

… form

…eate_event view

# Conflicts: # static/css/style.css

stefdworschak

@hebs87 This is a really good PR! Just a few general comments.

My main concern is that you changed and deleted quite a lot of migrations from what I can see. Could you please see what happened here and if instead of changing existing migrations can create new migrations making the changes you want?

stefdworschak · 2020-10-23T20:51:28Z

accounts/migrations/0002_auto_20201022_1553.py

@@ -1,18 +0,0 @@
-# Generated by Django 3.1.1 on 2020-10-22 15:53


Why did you remove this migration?

After pulling in and merging the latest PR, I kept getting an error when trying to navigate to the create_event page, which was to do with the CustomUser model. StackOverflow suggested that I clear the existing migrations and then run the makemigrations and migrate commands again, which resolved the issue. How do I get the previous migrations back?

When this happens what I would first do is just try to delete the db.sqlite3 file. If you have an existing file that you have done work on and others it might happen that there are issues then with the migrations. By deleting the database this should give you a clean slate. Running makemigrations then should just show "No changes needed" and on migrate it would just recreate the db with the most up-to-date models.

To remove the the changes to the migrations you can run git revert <commit_id> (this will delete the changes, but keep the commit history) and you will then have to push the changes to your fork (probably with -f at the end). You can get the commit ID from the list of commits above or by running git log.

Cool, I'll keep that in mind going forward and delete the db.sqlite3 file as the first port of call 👍 I ran into some trouble with reverting the branch though, so I had to do a hard reset instead and force push to the branch. A couple of my previous commits are now gone from the history, but all the migration files are reverted and my new changes are also added back in.

stefdworschak · 2020-10-23T20:53:19Z

hackathon/forms.py

+
+
+class HackathonForm(forms.ModelForm):
+    display_name = forms.CharField(


Please add a docstring for the class

Sorry, I normally do add docstrings! This one must have slipped the net. I've added this now and it will be visible when I push the changes.

stefdworschak · 2020-10-23T20:58:17Z

hackathon/models.py

-    description = models.TextField()
-    start_date = models.DateTimeField()
-    end_date = models.DateTimeField()
+    display_name = models.CharField(default="", max_length=254, blank=False, null=True)


Why are you adding blank=False, null=True for all of the below fields? They are all required so should not be null.

This was just from previous experience - when setting a field on an existing model to blank=False and there are existing records in the DB, I've received errors in the past when running the migrations again, or it has asked me to set a value for any existing blank fields. To resolve this, I've had to set null=True on the relevant fields, so this is a force of habit! I've removed null=True from the relevant fields now and it will be visible when I push the changes to the existing PR.

Sure. That's fine, but I think it's either null=True or set a default. And as per Django documentation default="" for Char and TextFields is the preferred solution.

Perfect, makes sense. I'll keep that in mind going forward 👍

stefdworschak · 2020-10-23T21:02:00Z

hackathon/templates/hackathon/create-event.html

+{% endblock %}
+
+{% block js %}
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-datetimepicker/2.5.20/jquery.datetimepicker.full.min.js"


Do you need this and the CDN at the top of the template as well?

When you mention the CDN at the top of the template, are you referring to the link tag? If so, yes they are both needed. The link tag is for the datetimepicker CSS, and the script tag is for the relevant JS.

Cool. That's okay then

stefdworschak · 2020-10-23T21:02:21Z

hackathon/templates/hackathon/create-event.html

+          integrity="sha256-FEqEelWI3WouFOo2VWP/uJfs1y8KJ++FLh2Lbqc8SJk=" crossorigin="anonymous">
+  </script>
+  <script>
+    $(document).ready(function () {


Could you please extract the JS to an external JS script file?

The datetimepicker wouldn't render when I moved the JS into script.js, so I've had to move it into a new JS file - datetimepicker.js - and import it into the create_event.html template. This change will be visible once it is pushed to the existing PR.

stefdworschak · 2020-10-23T21:14:52Z

hackathon/views.py

+
+        template = "hackathon/create-event.html"
+        form = HackathonForm()
+        context = {


Not sure you need to create a context dict just for one key. I'd just pass the form dict directly to the render function.

This is just a personal preference, but changed as requested.

stefdworschak · 2020-10-23T21:16:45Z

hackathon/views.py

+def create_event(request):
+    """ Allow users to create hackathon event """
+
+    if request.method == 'GET':


I would put this in an else clause for the if request.method == 'POST' instead of having two serparate if statements.

Again, this is my employer's preference, which is why I did it this way. I've changed that line to an else clause instead now.

stefdworschak · 2020-10-23T21:18:12Z

hackathon/views.py

+        # Submit form and save record
+        if form.is_valid():
+            form.instance.created_by = request.user
+            form.instance.start_date = start_date


Do you need to actually assign start and end_date again or should that not be in the POST already?

I did this becuase I've formatted the start_date and end_date a couple of lines above it (for date validation), so I passed in the formatted value to the form fields. But, you're right, I've added the input format to the relevant form field anyway so these two lines are unneeded. I've removed them now.

stefdworschak · 2020-10-23T21:19:08Z

static/css/style.css

@@ -1,166 +1,170 @@
-:root {


what's happended here? Did you replace the whole file?

Nope, not sure why it's showing like that there. I added a class but didn't change anything else in the file. I had to re-add the class once I pulled and merged the latest PR, so maybe that may have thrown git? I've checked the repo though and all the existing classes are still there, as well as my new class.

stefdworschak · 2020-10-23T21:20:16Z

templates/includes/navbar.html

@@ -18,6 +18,10 @@
                    </a>
                    <div class="dropdown-menu" aria-labelledby="navbarHackathons">
                        <a class="dropdown-item" href="{% url 'hackathon:hackathon-list' %}">Events</a>


In line with my earlier comment, I would rename "Events" to "View Hackathons" and "Create Event" to "Create Hackathon" please.

Done. The "Events" link wasn't one that I added by the way, but I've changed it while in the file.

…dated latest changes following PR comments

stefdworschak

LGTM

hebs87 added 25 commits October 16, 2020 22:31

Added unversioned local directories to .gitignore

50fd52c

Merge branch 'master' into feature/admin-create-hackathon

ae5fb4c

# Conflicts: # .gitignore

Merged upstream updates into local branch and re-added local unversio…

7915d66

…ned directories to .gitignore

Added theme field to Hackathon model and added blank and null attribu…

ddcc50a

…tes to required fields

Created HackathonForm to enable rendering template form in frontend

6e76f09

Added max_length attribute to Hackathon model theme field and ran mig…

82226e7

…rations

Created basic create-event.html template for creating hackathon event

67079ce

Created basic view and url to render create-event.html template

8bd82d4

Update create_event view to pass in blank form context to template an…

c503d34

… added TODOs

Merge branch 'master' into feature/admin-create-hackathon

86aaa42

# Conflicts: # .gitignore # hackathon/urls.py # hackathon/views.py

Merged PR changes from upstream repo

14f7a0b

Rendered date picker in frontend form to enable date selection

d14fa2a

Merge branch 'master' into feature/admin-create-hackathon

2718a8a

# Conflicts: # templates/base.html

Added datetimepicker to start_date field for creating hackathon event

caa3a13

Introduced XDSoft DateTimePicker for start_date form field

cbb4497

Introduced XDSoft DateTimePicker for end_date form field

825afe7

Merge branch 'master' into feature/admin-create-hackathon

fd08750

# Conflicts: # .gitignore

Specified datetime display format for datetimepicker

9c253d2

Added labels and basic form validation and form labels for HackathonForm

b1d8689

Added logic to validate start and end date and submit hackathon event…

120c98f

… form

Set options for datetimepicker

abfebf6

Added placeholders to HackathonForm fields

269a96f

Added logic to redirect to relevant views in conditional checks in cr…

7194042

…eate_event view

Merge branch 'master' into feature/admin-create-hackathon

7745d3d

# Conflicts: # static/css/style.css

Merged latest upstream changes into current branch

8839493

hebs87 changed the title ~~Feature/admin create hackathon~~ #A02 - As admin, I would like to create new hackathon events Oct 23, 2020

stefdworschak requested changes Oct 23, 2020

View reviewed changes

hebs87 added 2 commits October 24, 2020 00:32

Reset branch to previous commit to retrieve deleted migrations and up…

8f80675

…dated latest changes following PR comments

Fixed urls to match new views in hackathon/urls.py and re-ran migrations

b3d7b72

stefdworschak approved these changes Oct 24, 2020

View reviewed changes

stefdworschak merged commit 0c629a1 into Code-Institute-Community:master Oct 24, 2020

stefdworschak added the hacktoberfest-accepted Accepted PR during Hacktoberfest label Oct 24, 2020

stefdworschak linked an issue Oct 25, 2020 that may be closed by this pull request

#A02. As Admin, I would like to create new Hackathon events. #40

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#A02 - As admin, I would like to create new hackathon events #99

#A02 - As admin, I would like to create new hackathon events #99

hebs87 commented Oct 23, 2020

stefdworschak left a comment

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

stefdworschak Oct 23, 2020 •

edited

Loading

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak Oct 23, 2020

hebs87 Oct 23, 2020

stefdworschak left a comment

		@@ -1,18 +0,0 @@
		# Generated by Django 3.1.1 on 2020-10-22 15:53



		class HackathonForm(forms.ModelForm):
		display_name = forms.CharField(

#A02 - As admin, I would like to create new hackathon events #99

#A02 - As admin, I would like to create new hackathon events #99

Conversation

hebs87 commented Oct 23, 2020

User Story ID:

Description of PR:

Tests:

Know bugs/errors:

Screenshots:

Does this introduce a breaking change

stefdworschak 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

stefdworschak Oct 23, 2020 • edited Loading

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

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stefdworschak left a comment

Choose a reason for hiding this comment

stefdworschak Oct 23, 2020 •

edited

Loading