This is the intranet used by the volunteers of the assosication Paris est Ludique.
It is built from the boilerplate React Cool Starter, on the top of React, Redux, React Router and Express.
1. You can start by cloning the repository on your local machine by running:
git clone https://github.com/forceoranj/intranet.git
cd intranet2. Install all of the dependencies:
npm install yarn
yarn3. Start to run it:
yarn dev # Build, hosts, and hot reload saved modificationsNow the app should be running at http://localhost:3000
Edit files with one of these HTML/CSS/TypeScript editors:
- Atom with TypeScript plugin
- Visual Studio Code
- Webstorm 2018.1
- Sublime Text with Typescript-Sublime-Plugin
I use cross-env to set and use environment variables across platforms. All of the scripts are listed as following:
yarn <script> |
Description |
|---|---|
dev |
Runs your app on the development server at localhost:3000. HMR will be enabled. |
dev:build |
Bundles server-side files in development mode and put it to the ./public/server. |
start |
Runs your app on the production server only at localhost:8088. |
build |
Bundles both server-side and client-side files. |
build:server |
Bundles server-side files in production mode and put it to the ./public/server. |
build:client |
Bundles client-side files in production mode and put it to the ./public/assets. |
analyze:server |
Visualizes the bundle content of server-side. |
analyze:client |
Visualizes the bundle content of client-side. |
lint |
Lints all .tsx?, .jsx? and .scss files. |
lint:code |
Lints all .tsx? and .jsx? files (With --fix to auto fix eslint errors). |
lint:type |
Runs type checking for .tsx? files. |
lint:style |
Lints all .scss files (With --fix to auto fix stylelint errors). |
lint:format |
Formats all files except the file list of .prettierignore. |
test |
Runs testing. |
test:watch |
Runs an interactive test watcher. |
test:cov |
Runs testing with code coverage reports. |
test:update |
Updates jest snapshot. |
Here is the structure of the app, which serves as generally accepted guidelines and patterns for building scalable apps.
.
├── public # Express server static path and Webpack bundles output
│ ├── favicon.ico # App favicon
│ ├── logo192.png # App logo small
│ ├── logo512.png # App logo large
│ └── manifest.json # App favicon and logo manifest
├── src # App source code
│ ├── config # App configuration by environments
│ │ ├── default.ts # Default settings
│ │ ├── index.ts # Configuration entry point
│ │ └── prod.ts # Production settings (overrides the default)
│ ├── components # Reusable components
│ ├── pages # Page components
│ ├── app # App root component
│ ├── store # Redux store creator, actions + reducers (a.k.a slice)
│ ├── services # API calls
│ ├── utils # App-wide utils (e.g. mock store creator for testing etc.)
│ ├── static # Static assets (e.g. images, fonts etc.)
│ ├── theme # App-wide style and vendor CSS framework
│ ├── types # App-wide type definitions
│ ├── client # App bootstrap and rendering (Webpack entry)
│ ├── routes # Routes configuration for both client-side and server-side
│ └── server # Express server (with Webpack dev and hot middlewares)
├── webpack # Webpack configurations
├── jest # Jest configurations
├── babel.config.js # Babel configuration
├── tsconfig.json # TypeScript configuration
├── postcss.config.js # PostCSS configuration
├── .eslintrc.js # ESLint configuration
├── .stylelintrc.js # stylelint configuration
└── nodemon.json # nodemon configuration
Thanks goes to these people (emoji key):
 pikiou 💻 📖 🚧 |
This project follows the all-contributors specification. Contributions of any kind welcome!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent