https://github.com/codeconnoisseur74/thorin-flask-app
Thorin mock Company fan page
https://github.com/codeconnoisseur74/thorin-flask-app
blog careers company-site
Last synced: 3 months ago
JSON representation
Thorin mock Company fan page
- Host: GitHub
- URL: https://github.com/codeconnoisseur74/thorin-flask-app
- Owner: CodeConnoisseur74
- Created: 2023-10-14T12:30:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-11T13:22:27.000Z (over 1 year ago)
- Last Synced: 2025-06-08T16:08:56.350Z (4 months ago)
- Topics: blog, careers, company-site
- Language: JavaScript
- Homepage: https://ci-thorin-flask-app-6f96e88af480.herokuapp.com/
- Size: 7.53 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Readme.md
# ** **
Link to Live Project
## Table of Contents
- [\*\* \*\*](#-)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [UX](#ux)
- [User Stories](#user-stories)
- [Wireframes](#wireframes)
- [Features](#features)
- [Features Left to Implement](#features-left-to-implement)
- [Technologies Used](#technologies-used)
- [Languages Used](#languages-used)
- [Frameworks, Libraries \& Programs Used](#frameworks-libraries--programs-used)
- [Testing](#testing)
- [Deployment](#deployment)
- [Heroku](#heroku)
- [Forking the GitHub Repository](#forking-the-github-repository)
- [Cloning the GitHub Repository](#cloning-the-github-repository)
- [Credits](#credits)
- [Code](#code)
## Introduction
## UX
### User Stories
| ID | As a... | I Want To Be Able To... | So That I Can... |
| --- | --- | --- | --- |
| 01 | | | |
| 02 | | | |
| 03 | | | |
### Wireframes
- No wireframes were required for this project.
## Features
*
*
*
*Intro welcome message with instructions.
![Welcome message]()
![]()
### Features Left to Implement
*
*
*
*
*
## Technologies Used
### Languages Used
*[Python](https://en.wikipedia.org/wiki/Python_%28programming_language%29 "https://en.wikipedia.org/wiki/Python_(programming_language)")
*[VS Code](https://en.wikipedia.org/wiki/Visual_Studio_Code)
*[Pycharm](https://en.wikipedia.org/wiki/JetBrainse)
*[Heroku](https://en.wikipedia.org/wiki/Heroku)
### Frameworks, Libraries & Programs Used
*[Random](https://docs.python.org/3/library/random.html)
## Testing
PEP8, flake and Black Formatter was used to test and find errors. Only syntax errors were found. Renaming of functions and variables according to PEP8 documentation was carried out and refactored using PyCharm before confirming and copying over to VSCode in Gitpod.
## Deployment
### Heroku
This program was deployed to Heroku, following the below steps:
```
Push most up-to-date code to Github
Create a list of requirements by typing the following into the terminal: pip3 freeze > requirements.txt
Push the requirements to Github
Logon to Heroku
Select create new app
Add app name
Add app region
Select 'Create app'
Open up the Settings tab, on the top ribbon
In 'Config Vars' select 'Reveal Config Vars'
Add 'PORT' as a key and '8000' as a value
In 'Buildpacks' select 'Add buildpack' and choose python. Then, repeat for nodejs (order is important; python first followed by nodejs)
Navigate to 'Deploy' on the top ribbon
In 'Deployment method', select 'Github', once clicked it should say 'connected'
Enter a repository in Github to connect to and click 'Search'
Once repository has been found, click 'Connect' to link new app to Github repository
In 'Automatic deploys', select the 'Enable Automatic Deploy' option
To view your command line on the Heroku platform, once a new code has been pushed to Github, log on to Heroku
Select the required app that appears on your home screen
Select 'Open app' on the right hand side of the screen
The app should appear in a new tab on the web browser
The link to my Heroku app is: https://cli-battleship-game.herokuapp.com/
```
### Forking the GitHub Repository
The following steps can be used to fork the GitHub repository:
- On GitHub navigate to the main page of the repository.
- The 'Fork' button can be found on the top righthand side of the screen.
- Click the button to create a copy of the original repository.
### Cloning the GitHub Repository
The following steps can be used to clone the GitHub repository:
- On GitHub navigate to the main page of the repository.
- Above the list of files select 'Code'.
- Three options are provided, HTTPS, SSH and GitHub CLI. Select the appropriate option and click the 'Copy' button next to the URL.
- Open Git Bash.
- Change the working directory to the location for the cloned directory.
- Type git clone and paste the copied URL.
- Press 'Enter' to create the clone.
## Credits
### Code
* Credit and articles etc that we have copied code from
* [PEP8](https://peps.python.org/pep-0008/)
* []()
- Any other credits