Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 4.11 KB

README.md

File metadata and controls

73 lines (48 loc) · 4.11 KB
Raw

SoPra FS19 - Client Template

                                ad88888ba     ,ad8888ba,    88888888ba   88888888ba          db
                               d8"     "8b   d8"'    `"8b   88      "8b  88      "8b        d88b
                               Y8,          d8'        `8b  88      ,8P  88      ,8P       d8'`8b
                               `Y8aaaaa,    88          88  88aaaaaa8P'  88aaaaaa8P'      d8'  `8b
                                 `"""""8b,  88          88  88""""""'    88""""88'       d8YaaaaY8b
                                       `8b  Y8,        ,8P  88           88    `8b      d8""""""""8b
                               Y8a     a8P   Y8a.    .a8P   88           88     `8b    d8'        `8b
                                "Y88888P"     `"Y8888Y"'    88           88      `8b  d8'          `8b

STOP! First you have to be familiar with this before you start

Read and go through those Tutorials, It will make your life easier!

  • Read the React Docs
  • Do this React Getting Started Tutorial (it doesn’t assume any existing React knowledge)
  • Get an Understanding of CSS and HTML!

Once you have done all of this, in the template there are two main external dependencies that you should look at:

  • styled-components It removes the mapping between components and styles (i.e. external css files). This means that when you're defining your styles, you're actually creating a normal React component, that has your styles attached to it
  • react-router-dom Declarative routing for React being a collection of navigational components that compose declaratively with your application.

IDE Recommendation

As a student, you have the possibility with JetBrains to obtain a free individual license and have access to several IDEs. We recommend you to use WebStorm for your front-end. Once you have downloaded and installed it, you can add the following WebStorm plugins:

Go to Preferences --> Plugins --> Browse Repositories and look for:

  • styled-components (provides coding assistance like CSS Highlighting for Styled Components)
  • prettier (a smart code formatter)
  • Material Theme UI (Material Theme for Jetbrains IDEs, allowing a total customization of the IDE including Themes, Color Schemes, Icons and many other features.)

Feel free to use other IDEs (e.g. VisualStudio) if you want.

Prerequisites and Installation

In the project directory, you can run:

npm install

Install all dependencies. This has to be done before starting the application.

npm run dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console (use Google Chrome!).

npm run test

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

npm run build

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.

Learn More

To learn React, check out the React documentation.

Template by Lucas Pelloni, SoPra FS19