For example; Yoga at home is a site created to teach yoga and to make yoga more accessible. The site will be targeted toward people of all levels from beginner to advanced by having three course levels with varying course material. Yoga at home allows its users to view the live sessions calendar, to buy courses and to sign up for newsletters.
In this section, you should go over the different parts of your project, and describe each in a sentence or so. You will need to explain what value each of the features provides for the user, focusing on who this website is for, what it is that they want to achieve and how your project is the best way to help them achieve these things.
-
Navigation Bar
- Featured on all three pages, the full responsive navigation bar includes links to the Logo, Home page, Courses and Sign Up page and is identical in each page to allow for easy navigation.
- This section will allow the user to easily navigate from page to page across all devices without having to revert back to the previous page via the ‘back’ button.
-
The landing page image
- The landing includes a photograph with text overlay to allow the user to see exactly what the website is about.
- This section introduces the user to Yoga at home with an eye catching animation to grab their attention
-
Ethos Section
- The ethos section will allow the user to see the benefits of taking a yoga class, as well as the benefits of yoga overall.
- This user will see the value of signing up for the yoga classes and/or yoga live sessions. This should encourage the user to consider yoga as their form of exercise.
-
Live sessions section
- This section will allow the user to access the live zoom classes and to know when they will happen.
- This section will be updated as these times change to keep the user up to date.
-
The Footer
- The footer section includes links to the relevant social media sites for Love Running. The links will open to a new tab to allow easy navigation for the user.
- The footer is valuable to the user as it encourages them to keep connected via social media
-
Courses
- The courses will provide the user with three pricing cards with a short description.
- This section is valuable to the user as they will be able to buy the courses appropriate to their needs.
-
The Sign Up Page
- This page will allow the user to get signed up to Yoga at home newsletters. The user will be asked to submit their full name and email address and if they would like to leave a comment (optional).
- Instagram widget on home page
In this section, you need to convince the assessor that you have conducted enough testing to legitimately believe that the site works well. Essentially, in this part you will want to go over all of your project’s features and ensure that they all work as intended, with the project providing an easy and straightforward way for the users to achieve their goals.
In addition, you should mention in this section how your project looks and works on different browsers and screen sizes.
You should also mention in this section any interesting bugs or problems you discovered during your testing, even if you haven't addressed them yet.
If this section grows too long, you may want to split it off into a separate file and link to it from here.
- HTML
- No errors were returned when passing through the official W3C validator
- CSS
- No errors were found when passing through the official (Jigsaw) validator
You will need to mention unfixed bugs and why they were not fixed. This section should include shortcomings of the frameworks or technologies used. Although time can be a big variable to consider, paucity of time and difficulty understanding implementation is not a valid reason to leave bugs unfixed.
This section should describe the process you went through to deploy the project to a hosting platform (e.g. GitHub)
- The site was deployed to GitHub pages. The steps to deploy are as follows:
- In the GitHub repository, navigate to the Settings tab
- From the source section drop-down menu, select the Master Branch
- Once the master branch has been selected, the page will be automatically refreshed with a detailed ribbon display to indicate the successful deployment.
The live link can be found here - https://code-institute-org.github.io/love-running-2.0/index.html
In this section you need to reference where you got your content, media and extra help from. It is common practice to use code from other repositories and tutorials, however, it is important to be very specific about these sources to avoid plagiarism.
You can break the credits section up into Content and Media, depending on what you have included in your project.
- The text for the Home page was taken from Wikipedia Article A
- Instructions on how to implement form validation on the Sign Up page was taken from Specific YouTube Tutorial
- The icons in the footer were taken from Font Awesome
- The photos used on Yoga at home are from https://www.pexels.com/
Congratulations on completing your Readme, you have made another big stride in the direction of being a developer!
Below you will find a couple of extra tips that may be helpful when completing your project. Remember that each of these projects will become part of your final portfolio so it’s important to allow enough time to showcase your best work!
-
One of the most basic elements of keeping a healthy commit history is with the commit message. When getting started with your project, read through this article by Chris Beams on How to Write a Git Commit Message
- Make sure to keep the messages in the imperative mood
-
When naming the files in your project directory, make sure to consider meaningful naming of files, point to specific names and sections of content.
- For example, instead of naming an image used ‘image1.png’ consider naming it ‘landing_page_img.png’. This will ensure that there are clear file paths kept.
-
Do some extra research on good and bad coding practices, there are a handful of useful articles to read, consider reviewing the following list when getting started:
Getting started with your Portfolio Projects can be daunting, planning your project can make it a lot easier to tackle, take small steps to reach the final outcome and enjoy the process!