Git Product home page Git Product logo

code-institute-pp3-readme-template's Introduction

Project 3 README

Here is where you should describe your project, what it does, why you made it and a brief explanation of how it works.

Add a link to the live version of the site here Here

Table of Contents

  1. UX/UI

  2. Features

  3. Technologies Used

  4. Testing

  5. Deployment

  6. Credits

  7. Acknowledgements

  8. Disclaimer

UX

Site Goals

Describe the goals of your site in detail, what are you trying to achieve and why.

User Stories

As a site user:

  • I want to

UI

Talk about your python app. Describe your choices, what it is and what it does. Post screenshots and diagrams of how your app logic works.

Features

Splash Screen

  • Add each feature/function throughout your app and add a description of how it works with screenshots.
  • Add another section like this for any subsequent features of your app.

Existing Features

  • List your features that are not covered above and add screenshots and a description.

Features Left to Implement

  • Add any features that you did not implement and why. ex. ran out of time.

Technologies Used

  • Here you will list and link to all the technologies you have used for your project.

  • Github - Github was used for storing my code and version control.

Testing

Link to a seperate testing doc Here or add all your manual testing in this section.

Deployment

Describe the steps you took to deploy here. Describe it as though you are guiding someone to run your project locally.

Fork the project

  1. Create a Github account or login here
  2. On GitHub, go to Insert Repo Link here
  3. Look for the fork button, top right under your profile picture and click it

Clone the project

  1. Fork the project as detailed in the steps above
  2. Click the code button
  3. Select to clone with HTTPS/SSH/GithubCli and click the copy icon on the right
  4. In your editor software eg. GitBash, GitPod, VSCode open the terminal
  5. Navigate to the destination which you want to be the destination for the clone
  6. Type gitclone if you selected HTTPS or SSH and paste the copied code. If you used GithubCLi just paste the code you copied
  7. Press Enter to create your clone

Deploy to Heroku

1.List ALL the steps you took to deploy the project to Heroku

Credits

Code

  • Add links to and describe every piece of code that you used for this project that was not written by you. You do not have to credit W3 schools, MDN or if the code is from the official language/framework docs.

Content

  • Link to every piece of content such as text crediting the author.

Acknowledgements

I received inspiration for this project from

  • Add links here

Disclaimer

This project is for educational purposes only and will not be used for commercial use. All media has been credited and any similarities to other companies/websites/applications are purely unintentional.

code-institute-pp3-readme-template's People

Contributors

kenanwright1988 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.