Name of project
All about tree
-
is a great website to have simple reliable educational information on the
World Wide Web
-
Welcome to our trees website, here, we explore the fascinating world of trees,
from their different types to their importance in our environment whether
you're a natural lover, a student, or simply curious Join us as we discover
the beauty and significance of three together
He that plants trees, loves others besides himself Thomas Fuller
Table of contents
General info
Trees tend to be long-lived, some reaching several thousand years old. Trees
have been in existence for 370 million years. It is estimated that there are
around three trillion mature trees in the world. A tree typically has many
secondary branches supported clear of the ground by the trunk.
Screenshots
Technologies
- Node 20.6.0
- VSC code
- HTML
- CSS
- adobe illustrator
- slack
- GitHub
- Markdown
- agile methodology
Status
Project is: Done
Inspiration
Project by group-2
Contact
By [Ala, khant, Rasaq and Ashraf]
Instructions for use
Getting Started
1. `git clone git@github.com:HackYourFutureBelgium/template-markdown.git`
2. `cd template-markdown`
3. `npm install`
## Code Quality Checks
- `npm run format`: Makes sure all the code in this repository is well-formatted
(looks good).
- `npm run lint:ls`: Checks to make sure all folder and file names match the
repository conventions.
- `npm run lint:md`: Will lint all of the Markdown files in this repository.
- `npm run lint:css`: Will lint all of the CSS files in this repository.
- `npm run validate:html`: Validates all HTML files in your project.
- `npm run spell-check`: Goes through all the files in this repository looking
for words it doesn't recognize. Just because it says something is a mistake
doesn't mean it is! It doesn't know every word in the world. You can add new
correct words to the [./.cspell.json](./.cspell.json) file so they won't cause
an error.
- `npm run accessibility -- ./path/to/file.html`: Runs an accessibility analysis
on all HTML files in the given path and writes the report to
`/accessibility_report`
## Continuous Integration (CI)
When you open a PR to `main`/`master` in your repository, GitHub will
automatically do a linting check on the code in this repository, you can see
this in the[./.github/workflows/lint.yml](./.github/workflows/lint.yml) file.
If the linting fails, you will not be able to merge the PR. You can double check
that your code will pass before pushing by running the code quality scripts
locally.
## Repo Setup
- Give each member **_write_** access to the repo (if it's a group project)
- Turn on GitHub Pages and put a link to your website in the repo's description
- Go to _General_ Section > check **Discussions**
- In the _Branches_ section of your repo's settings make sure the
`master`/`main` branch must:
- "_Require a pull request before merging_"
- "_Require approvals_"
- "_Dismiss stale pull request approvals when new commits are pushed_"
- "_Require status checks to pass before merging_"
- "_Require branches to be up to date before merging_"
- "_Do not allow bypassing the above settings_"