School Projects
A playground for testing out all new tech for school, such as homework & school assignments. The goal of this project is to learn and understand CSS Grid, React Backend & Frontend fully so that I can implement it in coming school and work related projects.
Table of contents
- Quick start
- Status
- What's included
- Bugs and feature requests
- Contributing
- Community
- Versioning
- Creator
- Copyright and license
Quick start
Download
Navigate the a directory on your computer were you are working on sites and run this command:
git clone https://github.com/bromso/school-projects.git
Install packages
Navigate the site’s directory and run this command.
npm i
Start developing
Navigate the site’s directory and start it up. Will be located on url: http://localhost:8000
gatsby develop
Develop & Test on Smartphone
Navigate the site’s directory and start it up. Wait until Gatsby has fully started and you will find the IP to put in your browser on your smartphone.
gatsby develop -H 0.0.0.0
Start Storybook
Navigate the site’s directory and start it up. Will be located on url: http://localhost:6006
npm run storybook
Local --> Stage --> Production
Name | Local | Stage | Production |
---|---|---|---|
GatsbyJS App | http://localhost:8000 | https://bromso-schoolprojects.netlify.app/ | |
Storybook: UI Components | http://localhost:6006 |
Status
What's included
Dependencies
I recommended to have these CLI's and dependencies in order to download and install everything without a clitch.
Logo | Name | Comments |
---|---|---|
Homebrew | Package manager (for Mac) | |
NVM | Node & NPM Version Manager | |
NodeJS | JavaScript Runtime Engine | |
NPMJS | Node Page Manager | |
GatsbyJS | Site Generator | |
Storbyook | UI Component Explorer |
Tech Stack
The application uses these technologies.
Logo | Name | Comments |
---|---|---|
HTML5 | Markup language | |
CSS3 | Styling language | |
Husky | Git message validator | |
Commitlint | Git linter | |
Editorconfig | IDE coding styles | |
Semantic Release | Versioning tool | |
Prettier | Code formatter | |
GatsbyJS | Site generator | |
ReactJS | JavaScript library | |
Styled-Components | ES6 & CSS to style components | |
Storbyook | UI Component Explorer |
Hosting
The application uses these hosting vendors.
Logo | Name | Comments |
---|---|---|
Github | Code repository | |
Netlify | Webpage hosting |
Contributing
No contributions are necessary because the project is just for showing teacher at school.
Bugs and feature requests
No bug and feature request are necessary because the project is just for showing teacher at school.
Versioning
For transparency into my release cycle and in striving to maintain backward compatibility, school-projects is maintained under the Semantic Versioning guidelines. Sometimes I screw up, but I adhere to those rules whenever possible.
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
Type | Explanation | Semver (eg. 1.0.0) | Git Message Example |
---|---|---|---|
fix | A bug fix | x.x.1 | fix: update package.json |
feat | A new feature | x.1.x | feat: add new eslint to package.json |
BREAKING CHANGE | A major change | 1.x.x | BREAKING CHANGE: upgrade to strapi 3 & gatsby 3 |
docs | Documentation improvements | docs: update README.md | |
style | Changes made white-space, formatting, missing semi-colons, etc | style: add styles in breadcrumb component | |
refactor | A code change that neither fixes a bug nor adds a feature | refactor: fixed better intendation in index.html | |
perf | Performance improvements | perf: add tree-shaking to webpack | |
test | Add missing tests | test: add test to .travis.yml | |
chore | Changes the build process | chore: update .travis.yml & netlify.toml |
See the Releases section of our GitHub project for CHANGELOG for each release version of MaterialUI projects.
Creator
Avatar | Name | Website | |
---|---|---|---|
Jonas Bröms | jonasbroms@icloud.com | jonasbroms.com |
Coding conventions
Copyright and license
This project is licensed under the terms of the MIT license. For more information, click here.