Portfolio Project [NUMBER]: [MODULE NAME] - Code Institute - Deadline [DEADLINE DATE]
BRIEF INTRODUCTION HERE (ABOUT 5 LINES)
A live of the website can be found HERE [INSERT LINK TO DEPLOYED SITE HERE] [Insert responsive gif/image here]
BRIEF INTRODUCTION TO UX HERE (ABOUT 3 LINES)
VISION OF THE PROJECT HERE (ABOUT 15 LINES)
- AIM 1
- AIM 12
- AIM 3
- MORE AIMS...
- TARGET 1
- TARGET 12
- TARGET 3
- MORE TARGETS...
- STORY 1
- STORY 12
- STORY 3
- MORE STORIES...
| Opportunity/Feature | Feasibility/Viability (score out of 5) | Level of Importance (score out of 5) | In or out? |
|---|---|---|---|
| FEATURE 1 HERE | F/V SCORE HERE | IMPORTANCE SCORE HERE | IN OR OUT? |
| FEATURE 2 HERE | F/V SCORE HERE | IMPORTANCE SCORE HERE | IN OR OUT? |
| FEATURE 3 HERE | F/V SCORE HERE | IMPORTANCE SCORE HERE | IN OR OUT? |
| MORE FEATURES HERE | F/V SCORE HERE | IMPORTANCE SCORE HERE | IN OR OUT? |
| Average Viability x number of features: SCORE HERE |
Sum of Importance: SCORE HERE |
EXPLAINATION OF TABLE HERE
The table above has been plotted into a graph (below) to easily visualise the features that will be implemented into the web application and which ones won't be:
- The features in the pink section will be implemented
- The features in the grey section could/should be implemented however I might find it difficult due to my own coding knowledge
- The features in the turquoise section will not be implemented as it would be unwise to focus on these features until a later date
[IMAGE OF TABLE]
[IMAGE OF GRAPH]
ADVANTAGES/DISADVATAGES OF EITHER MMP OR MVP AND WHY WE ARE USING THE OPPOSING MODEL
By using the [INSERT MODEL HERE] model we will:
- FEATURE 1
- FEATURE 2
- FEATURE 3
- FEATURE 4
- MORE FEATURES...
LINEAR/NON-LINEAR?
On PAGENAME: FEATURES
On PAGENAME: FEATURES
On PAGENAME: FEATURES
The wireframes for the PROJECT NAME HERE website application were made with WIREFRAME SOFTWARE HERE, they can be found by viewing the images below. WHY MOBILE/DESKTOP FIRST APPROACH?
The wireframes were created during the website application's initial desgin process, as such there are changes between the layout of the wireframes and the final layout/design of the finished website.
A live demo of the website can be found HERE
This project was created on GitHub and Edited in GitPod by carrying out the following:
- A new repository was created using 'Code-Instutute-Org/gitpod-full-template'
- A meaningful name was given to the new repository and 'Create Repository' was selected
- The repository was then opened on GitHub by clicking the 'Gitpod' button to build the GitPod workspace which would allow me to build and edit the code used to make the PROJECT NAME HERE website/application
- Version control was used throughout the project using the following commands in the terminal using Bash
- git add . OR git add "file name" - to stage the changes and get them ready for being committed to the local repo.
- git commit -m "Description of the update" - to save the change and commit the change to the local repo
- git push - to push all committed shanges to the GitHub repo associated with the GitPod workspace
- Create the gitpod repo from the template via the gitpod button in github.
- Log in to Heroku and create a new app.
- Add the postgres add-on
- Complete the config vars section
- Link Heroku and GitHub accounts together
- Select the repo (via Heroku) that I wanted to make an app of and give it a name in Heroku.
- Click on deploy.
- Log in to your GitHub account
- Navigate to the repository HERE
- Select the 'Fork' button in the top right corner of the page (under your account image)
- The repo has now been copied into your own repos and you can work on it in your chosen IDE
- If you have any suggestions to make regards to the code to make the site better, you can put in a pull request
- If you want to create a web-app from the repo please follow the instructions in "Project Deployment"
- Log in to your GitHub account
- Navigate to the Repository HERE
- Select the 'Code' button above the file list on the right had side
- Ensure HTTPS is selected and click the clipboard on the right of the URL to copy it
- Open a new workspace in GitPod
- In the bash terminal type 'git clone [copy url here from step 4]'
- Press enter - the IDE will clone and download the repo
- You can then type 'python3 -m http.server' to host the website locally - this will not run the python file, only allow you to check how the web-app looks.
- If you want to create a web-app from the repo please follow the instructions in "Project Deployment"
- Log in to your GitHub account
- Navigate to the Repository HERE
- Select the 'Code' button above the file list on the right had side
- Select 'Open with GitHub Desktop'
- If you haven't already installed GitHub desktop application - you will need to follow the relevant steps to do this
- The repo will then be copied locally onto your machine
- If you want to create a web-app from the repo please follow the instructions in "Project Deployment"
- Log in to your GitHub account
- Navigate to the Repository HERE
- Select the 'Code' button above the file list on the right had side
- Select 'Download Zip'
- Once you have the Zip downloaded, open it with your prefered file decompression software
- You can then drag and drop the files from the folder into your chosen IDE or view/edit them on your local machine
- If you want to create a web-app from the repo please follow the instructions in "Project Deployment"
This project was deployed via Heroku by carrying out the following:
There are many ways to deploy the project locally on your own device. The ways I will explain here are: Forking, Cloning, GitHub Desktop and Zip Exctraction, the steps in these processes are outlined below:
If you want to make changes to the repo without affecting it, you can make a copy of it by 'Forking' it. This will make sure that the original repo remains unchanged.