This is a monorepo project, bootstrapped with Create React App and custom Gulp scripts. It uses:
Check the /docs folder to get a basic understanding of the project's architecture and coding standards before continuing.
- Install Node.js, if you haven't already (version 10.15.3).
- Install Yarn package manager, if you haven't already.
- Install LiveReload Chrome extension, for hot-reloading of CSS style changes.
- Install Webstorm IDE, then configure code style, install
Save Actionplugin and configure it like this screenshot; - Create
.npmrcconfiguration file based on.npmrc.example - Navigate to project root folder and install dependencies by running this command in terminal:
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in Chrome browser, then activate LiveReload extension.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner (or yarn test --watch -o to run in interactive watch mode).
See the section about running tests for more information.
Launches end-to-end integration tests using Cypress.
Build the app under web workspace and push it to GitHub pages documentation.
Builds the app for production to the /repos/web/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.
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.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
-
Enable pasting into command prompt with CTRL + V
- Install https://www.autohotkey.com/.
- Download and execute http://www.howtogeek.com/wp-content/uploads/gg/up/PasteCommandPrompt.ahk.
-
Install Git https://git-scm.com/downloads.
-
Enable Git password caching by installing https://gitcredentialstore._plex.com/.
-
Setup up git global configs at C:\Users\username (OPTIONAL)
- Option 1: Add this to .gitconfig file (usually located at C:\Users\username)
# This is Git's per-user configuration file.
[user]
name = Full Name
email = example@gmail.com
[alias]
st = status
ci = commit -m
amend = commit --amend
co = checkout
cp = cherry-pick
br = branch -avv
up = rebase
unstage = reset HEAD --
last = log -1 HEAD
lg = log --graph --pretty=format:'%C(auto)%h -%d %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit
[push]
default = simple
- Option 2: Using command line
# Tell Git who you are
git config --global user.name "Full Name"
git config --global user.email example@gmail.com
# Add some SVN-like aliases
git config --global alias.st "status"
git config --global alias.ci "commit -m"
git config --global alias.amend "commit --amend"
git config --global alias.co "checkout"
git config --global alias.cp "cherry-pick"
git config --global alias.br "branch -avv"
git config --global alias.up "rebase"
git config --global alias.unstage "reset HEAD --"
git config --global alias.last "log -1 HEAD"
git config --global alias.lg "log --graph --pretty=format:'%C(auto)%h -%d %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit"
git config --global push.default "simple"