school-frontend

Repository for School project & assignments

Table of Contents

• External Documents
• Milestones
• Projects
• Quick start
• Status
• What's included
• Bugs and feature requests
• Contributing
• Community
• Versioning
• Creator
• Copyright and license

External Documents

• Contributing
• Changelog
• Wiki

Projects

• Issues
• Pull requests
• Questions

Milestones

• Create App Architecture
• Create Git Architecture
• Set Coding Conventions
• Create Documentation Architecture
• Assignment #2
• Assignment #3
• Assignment #4
• Assignment #5
• Assignment #6

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-frontend.git

Install packages

Navigate the site’s directory and run this command.

yarn

Start developing

Navigate the site’s directory and start it up. Will be located on url: http://localhost:3000

yarn start

Build the project

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn build

Test the project

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Eject the project

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Status

What's included

File structure

🗄️ school-frontend
┃
┠── 📁 .github
┃    ├┄┄ 📁 ISSUE_TEMPLATE
┃    └┄┄ 📁 workflows
┃        └┄┄ 📄 semantic-release.yml
┃
┠── 📁 .vscode
┃   └┄┄ 📄 settings.json
┃
┠── 📁 docs
┃   └┄┄ 📁 img
┃
┠── 🖥️ client
┃
┠── ⚙️ server
┃
┠┄┄ 🐭 .editorconfig
┠┄┄ 📝 README.md
┠┄┄ 📝 CONTRIBUTING.md
┠┄┄ 📦 package.json
┖┄┄ 🧶 yarn.json

Model, View, Controller (MVC) Design Pattern

            ┏━━━━━━━━━━┓             ┏━━━━━━━━━━┓
    ┄┄┄┄┄┄┄┄◉    ⚙️     ┃        ┄┄┄┄◉    🛢️     ┃
   ┆        ┃Controller┃        ┆    ┃ Database ┃
   ┆        ┗━━○━━━◉━━━┛        ┆    ┗━━○━━━━━━━┛
┏━━◉━━━━━━━┓   ┆   ┆    ┏━━━━━━━◉━━┓    ┆
┃    💻    ○┄┄┄      ┄┄┄◉    ⚛️     ○┄┄┄┄
┃   View   ┃            ┃   Model  ┃
┗━━━━◉━━━━━┛            ┗━━━━━━━━━━┛
     ┆
┏━━━━◉━━━━━┓
┃    🧍    ┃
┃   User   ┃
┗━━━━━━━━━━┛

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Bugs, Feature requests, Questions & Need help

Have a bug, feature request, need help or just want to question? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

• 🐛 Report a bug
• 🛠️ Feature request
• 💬 Ask a question

Versioning

For transparency into my release cycle and in striving to maintain backward compatibility, odd-gat is maintained under the Semantic-Release & Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

See the Releases section of our GitHub project for CHANGELOG for each release version of odd-gat projects.

Creator

Avatar	Name	Email	Website	Instagram	Twitter	Facebook	LinkedIn	Github
	Jonas Bröms		jonasbroms.com

Copyright and license

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