nk095291 / portfolio Goto Github PK

Description

This project currently lacks a README file, which is essential for guiding new users, contributors, and developers through understanding the project's purpose, setting up the project locally, and contributing effectively.

Required Sections

1. About the Project

This section should provide an overview of the project, including its purpose, features, and any unique attributes that set it apart from similar projects. It should give visitors a clear understanding of what the project does and why it exists.

2. How to Install the Project Locally

A step-by-step guide on setting up the project environment on a local machine. This includes prerequisites, installation steps, and any necessary scripts to run the project successfully.

Additional Sections

1. How to Create an Issue

Guidelines for creating an issue, including what information to include to help maintainers and contributors understand and address the issue efficiently. This could cover aspects like a clear and descriptive title, a detailed issue description, steps to reproduce the issue, expected vs. actual outcomes, and attaching relevant screenshots or logs.

2. How to Create a Pull Request (PR)

Instructions on how to submit a PR, including branch naming conventions, what details to include in the PR description (such as which issue it addresses, changes made, testing carried out), and any coding or documentation standards to follow. It should also encourage contributors to link their PRs to the corresponding issues.

Helpful Resources

• Markdown Guide for Writing on GitHub
• Git and GitHub Learning Resources
• Creating a Pull Request
• Writing and Formatting on GitHub

Goal

The goal of this README is to ensure that anyone who comes across this project can easily understand its purpose, get it running on their own system, and know how to contribute effectively. This will not only help in getting more contributors but also in making the project more accessible to a wider audience.

Description

When attempting to access the homepage via http://127.0.0.1:8000/, users encounter a "page not found" error. This issue negatively affects the user experience by preventing access to the portfolio's initial landing page.

Expected Enhancements

1. Creation of a Homepage: We need to implement a homepage for the portfolio that introduces the creator. This page should act as the entry point for visitors, providing an overview of the creator's background, achievements, and the portfolio's purpose.

2. Navigation Update: The website's navigation bar should be updated to include a functional "Home" button. Clicking on "Home" should redirect users to the newly created homepage, facilitating easy and intuitive site navigation.

Visual Reference

Here's a screenshot illustrating the error encountered:

Recommended Action Steps

• Review and adjust the routing configuration to ensure the homepage is accessible.
• Design a welcoming and informative homepage that complements the overall portfolio theme.
• Conduct navigation functionality tests to verify the "Home" button redirects correctly to the homepage.

Helpful Resources

• Creating a Simple Homepage with HTML and CSS
• Understanding Django URL Dispatcher for Beginners
• Effective Web Design Principles