Bai Jaitrong, Grace Lee, Hans Ellis, Peter Philavanh, and Quin Asselin October, 2022
- Repository Description
- Github Pages Information
- Technologies Used
- Setup Instructions
- Example Tests
- Known Bugs
- License Information
- Photo Licensure
[describe what it does!]
This project was hand-built in tandem with a programming class taught by Epicodus. It contains use of {LANGUAGES} JavaScript, HTML, and formatting from both custom CSS and Bootstrap.
This project can be accessed on Github Pages via this [link](INSERT LINK HERE)
- Javascript
- HTML5
- CSS3
- Markdown Text
- Bootstrap 4.6.2
- Git
- Github and Github Pages [check spelling and such of these]
- ES Lint
- Babel (version)
- [WHAT APIS ARE USED??]
process to use this template:
- Installing all packages with $ npm install.
- Building the project using webpack with $ npm run build
- Starting a development server with $ npm run start
- Linting JS files in the src folder with $ npm run lint
- Running tests with Jest using $ npm run test
This webpage can be access by following the Github Pages linked above
Alternatively, the project can be opened via cloning/downloading repository:
- Download this repository from its Github Repository.
- Locate the download destination folder on your local machine.
- Unzip the downloaded folder if necessary.
- Enter the decompressed folder and open "index.html" in your prefered web browser.
(ADD STEPS ABOUT VERIFYING PROJECT IS SET UP CORRECTLY)
TESTING INFO
Test 1: "It should return 1 if a passage contains a single word."
Code:
const text = "hello";
wordCounter(text);
Expected Output: 1
In the event that (disallowed values) are entered into [MORE INFO] If you experience this issue, please message the producer of your current repository and include any relevant form/page information. Thank you for your patience as I work on any issues!
The page may experience formatting issues when opened on mobile devices or tablets/laptops in smaller windows. Page should still be legible but general project layout will shift in potentially unforeseen manner. Thus, it is recommended to open the HTML index page in browser or file explorer in as full a screen as hardware allows.
Additionally, included image does not scale-down to fit to smaller screen sizes and may take up a majority of the screen when scrolling through the site from a mobile (or other small-screened) device.
Quin Asselin, 2022. Available for distribution, modification, inspection, and application under GPLv3 License
Photo sourcing and respective licenses are as follows:
- [Image Title](link to image used)
- Describe use case or clause for use. [list who produced and when]
All photos are used with permission from their respective owners.