Modmail Web App
This project was bootstrapped with Create React App.
Command used to generate template
yarn create react-app modmail-web-ui --template typescript-eslint-prettier
Modmail
Used endpoints provided by the Modmail Server
Important Notes
Currently there are two required dependencies that not hosted within npm. In order to be
able to retrieve these dependencies, we use a file called .npmrc. By default, as soon as
you run npm install or yarn install, a .npmrc file should be generated that is a direct
copy of .npmrc.default. If for some reason this does not happen, or you
receive Not Found or 403 Forbidden, all you should have to do is delete the original .npmrc
within this directory that should be there, and either manually copy/paste the .npmrc.default
or run yarn install again.
These are required to be present in .npmrc
@NewCircuit:registry=https://npm.pkg.github.com
@demitchell14:registry=https://npm.pkg.github.com
Important Scripts
This can be run with either yarn or npm. The choice is yours.
| Command | Purpose |
|---|---|
yarn start |
Start a development instance of the web app on the local machine |
yarn run serve |
Starts a local HTTP server that serves the build directory |
yarn run build |
Builds an optimized and bundled version of the web app |
yarn run lint |
Runs ESLint on entire project |
yarn run prettier |
Executes Prettier on all .tsx? files in src |
yarn run profile |
Generates a visual diagram of what is inside a production build |