code-institute-submissions / vannesha2021-asiantravel Goto Github PK

With the Asian Travel blog, users benefit from a wide range of extensive functionality.

Users can register for an account, login, logout, and perform wide-ranging blog administrative tasks including creating a post, creating a draft, delete and manage posts, approve comments and of course delete posts. Users can also have a profile, which can be created and edited, and displayed to other users. Unauthenticated users meanwhile are able to view and open posts, view comments, comment, like and unlike posts, view a list of posts, and search for a specific post.

Python & Django

This project began with firstly generating the concept for the blog, before ideating the desirable user experience, actions and features - and the feasibility thereof. Following this, a high-level technical approach and interdependency mapping was carried out that would allow all necessary functionality to be created and included within the product, and identify areas of functionality overlap within the blog. The high-level technical approach permitted the decomposition of the work into user stories, which were created thus enabling development to commence. Following development work, extensive testing and validation was carried out to ensure code hygiene, performance and functionality for users.

The Asian Travel blog is primarily designed for ease of navigation, readership and administration. For blog viewers (both authenticated and unauthenticated), the primary focus is on readership and engagement with the content. This is reflected directly on the homepage, which surfaces blog articles listed by date posted and is paginated. The top navigation is straight-forward and enables users to sign up, or login (or log out, where relevant). On posts meanwhile, users are drawn through the article with engagement functions at the end including an intuitive heart icon to like/unlike a post and a clearly laid out comments box to create a comment. Blog administrators (authenticated users) meanwhile see additional optionality provided to them natively within the blog pages, including the ability to edit posts directly from the post page. The administration UX is similarly straightforward and creating a post is a guided process with several boxes for title, content, attachment, etc. centered on the page to maximise focus. Similarly, additional functions such as deleting a post, approving comments, etc. are simple one-click actions nested natively within the blog. Lastly, the user profiles allow for at-a-glance understanding of the blog user or author, so readers can quickly learn more about them. Meanwhile, for those users, the profile can be edited easily within the same page by selecting to edit the profile.

Colour Scheme

The colour scheme for this blog prioritizes white for background, and varying shades of grey within title boxes, etc. in order to ensure ease of reading, and place the focus on the content.

Typography

No font was chosen for this programme.

Imagery No imagery exists within the programme

• Clear navigation and button labels to relevant functions, dependent on authentication status.

• Ability for users to register an account, login and logout.

• Ability for users to create a profile for display on the blog, and to be able to edit this profile when necessary.

• Ability for authenticated users within the administration area to create a post, edit a post, delete a post, and create a draft.

• Authenticated users can review and approve blog post comments.

• Both authenticated and unauthenticated users can view posts, view lists of posts, like and unlike posts, and create a comment on a specific blog post.

• The site is also responsive and displays across multiple different device and screen types; and includes pagination

• Heroku

• GitPod

• Github

GIT

GIT was used for version control and utilising the Gitpod terminal to commit to Git and push to Github.

GitHub

Github is used to store the projects code after being pushed from Git. Github Projects was used to evidence of agile methodologies used during the project.

Slack Channel

Slack was used to communicate with other coders, and tutors to resolve issues which I was facing with the project.

Heroku

Heroku was used to deploy the project.

The PEP8 Validator was used to validate the code of the project to ensure there were no errors in the project.

The PEP8 Validator was used to validate the code of the project to ensure there were no errors in the project. PEP Online Validator-

Result : "All Right" In addition to that, I was also using the console to ensure that there were no errors in the whole duration of the project.

Add Post Test

1. Navigated to "Add Post" page
2. Entered data Title: Post 1, Content: ABC etc.
3. Clicked submit, or whatever you called the button
4. Navigated to Home page and saw the new post present

Edit Post Test

1. Navigated to Post 1
2. Changed content value to DEF, clicked edit
3. Navigated to Home Page
4. Saw that the content value had changed

Delete Post

1. Navigated to Post 1
2. Changed content value to DEF, clicked delete
3. Navigated to Home Page
4. Saw that the content has been deleted

View Comments

1. Created a comment
2. Created a comment
3. Entered comment 'test',
4. Navigated to Admin page
5. Approved comment
6. Saw that the comment was shown on page

Approve Comments

1. Created a comment
2. Entered comment 'test',
3. Navigated to Admin page
4. Approved comment
5. Saw that the comment was shown on page

Like and Unlike Post

1. Navigated to "Post" page
2. Clicked on Like button
3. The heart lighted up and the likes was shown as '1'

Unlike Post

1. Navigated to "Post" page
2. Clicked on Unlike button
3. The heart lighted up and the likes was shown as '0'

Account Registration

1. Navigated to the "Sign Up" button
2. Entered details as requested 3, Navigated to the admin page
3. User was indicated as created

Account Login

1. Navigated to the "Login" button
2. Entered details as requested 3, User was logged in and was able to view post, edit post and delete post

Account Logout

1. Navigated to the "Sign Out" button
2. A re-confirmation message was received
3. Once clicked, user was signed out

User Profile

1. Navigated to the "User Profile" button
2. Information was displayed as entered

Edit User Profile

1. Navigated to the "Edit profile" button
2. Information was chnaged and 'Saved'
3. Navigated to the "User Profile" button
4. Information was displayed as entered

The project can be accessed using Heroku.

There were no known bugs at the time of final deployment.

• Trying to create the Profile.form
• Final Git Push for the project

• https://www.flake8rules.com/
• https://www.geeksforgeeks.org/
• https://realpython.com/python-operators-expressions/
• https://getbootstrap.com/docs/4.0/components/buttons/