Code Monkey home page Code Monkey logo

school-projects's Introduction

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

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

Netlify Status David DM 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 Logo Homebrew Package manager (for Mac)
NVM Logo NVM Node & NPM Version Manager
NodeJS Logo NodeJS JavaScript Runtime Engine
NPMJS Logo NPMJS Node Page Manager
GatsbyJS Logo GatsbyJS Site Generator
Storybook Logo Storbyook UI Component Explorer

Tech Stack

The application uses these technologies.

Logo Name Comments
HTML5 Logo HTML5 Markup language
CSS3 Logo CSS3 Styling language
Husky Logo Husky Git message validator
Commitlint Logo Commitlint Git linter
Editorconfig Logo Editorconfig IDE coding styles
Semantic Release Logo Semantic Release Versioning tool
Prettier Logo Prettier Code formatter
GatsbyJS Logo GatsbyJS Site generator
ReactJS Logo ReactJS JavaScript library
Styled Components Logo Styled-Components ES6 & CSS to style components
StorybookJS Logo Storbyook UI Component Explorer

Hosting

The application uses these hosting vendors.

Logo Name Comments
Github Logo Github Code repository
Nelify Logo 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 Email Website
Jonas Bröms Avatar Jonas Bröms [email protected] jonasbroms.com

Coding conventions

Copyright and license

This project is licensed under the terms of the MIT license. For more information, click here.

school-projects's People

Contributors

semantic-release-bot avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.