Skip to content

Instantly share code, notes, and snippets.

@tonymontaro
Last active January 31, 2019 05:32
Show Gist options
  • Select an option

  • Save tonymontaro/909385f4a1a81537d559f5a3f8dcac41 to your computer and use it in GitHub Desktop.

Select an option

Save tonymontaro/909385f4a1a81537d559f5a3f8dcac41 to your computer and use it in GitHub Desktop.
Simplified README for CodeInstitute User-Centric Project

Your Project's Name

One or two paragraphs providing an overview of your project.

Essentially, this part is your sales pitch.

UX

  • Describe what the website is used for here

  • List what a user of your website can do while on your site (perhaps as bullet points). E.g:

    • Users would like to learn about the TheMonkees e.t.c.
    • Users would like to make Bookings ...
  • Share links to your wireframes/mockups here

Features

Existing Features

List each page and describe what it does. Example;

  • Music - This allows the user to listen to sample songs of TheMonkees

Features Left to Implement

Ideas or features not yet implemented which might be considered in the future e.g.

  • Live Page - watch live TheMonkees event

Technologies Used

In this section, you should mention all of the languages, frameworks, libraries, and any other tools that you have used to construct this project. For each, provide its name, a link to its official site and a short sentence of why it was used. Example;

  • CSS3 - The website uses CSS3 for styling all elements within the website.
  • HTML ...
  • Bootstrap ...

Testing

  • Go over all your pages and ensure they all look and work as expected

  • List any challenges you encountered during testing and how you solved them here. Example;

While testing the Music page, I notice that adjacent images are not properly aligned ...

A particularly useful form for describing your testing process is via scenarios, such as:

  1. Contact form:
    1. Go to the "Contact Us" page
    2. Try to submit the empty form and verify that an error message about the required fields appears
    3. Try to submit the form with an invalid email address and verify that a relevant error message appears
    4. Try to submit the form with all inputs valid and verify that a success message appears.
  • In addition, you should mention in this section how your project looks and works on different browsers and screen sizes.

  • If this section grows too long, you may want to split it off into a separate file and link to it from here.

Deployment

  • Simply describe how you deployed the website to GitHub Pages (if that's what you used) or any other hosting service. Include a link to the deployed application.

Credits

Content

Media

  • The photos used in this site were obtained from ...

Acknowledgements

  • I received inspiration for this project from X
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment