{{ Give a brief description of your project here. What is it for, how do you use it? }}
{{
Give a quick step-by-step guide on how to download and run your codebase.
It's ok to assume the reader is another developer here, so don't feel like you have to explain what a virtual environment is, etc.
Give directions like "clone the repo to your local machine", "create a virtual environment", "migrate the database", etc.
When you need to specify terminal commands, you can surround them with backticks, like so: python manage.py runserver
. This formats them as code in the markdown document. (The backtick key is to the left of the number 1 at the top of your keyboard.)
}}
![ {{ My ERD }} ]( {{ ./relative_path_to_your_entity_relationship_diagram }} )
-
Order stories by date ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
Styled "new story" form ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
Story images ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
Log-in/log-out ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
"Account view" page ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
"Create Account" page ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
View stories by author ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
"Log-in" button only visible when no user is logged in/"Log-out" button only visible when a user is logged in ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
"Create Story" functionality only available when user is logged in ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
Add categories to the stories and allow the user to search for stories by category. ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
Add the ability to update and delete stories (consider permissions - who should be allowed to update or and/or delete stories). ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
Add the ability to “favourite” stories and see a page with your favourite stories. ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
Our form for creating stories requires you to add the publication date, update this to automatically save the publication date as the day the story was first published (maybe you could then add a field to show when the story was updated). ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )
-
Gracefully handle the error where someone tries to create a new story when they are not logged in. ![ {{ Description of image }} ]( {{ ./relative_path_to_image_file }} )