Node - Showroom Server
Synopsis
Server side for @opuscapita/react-showroom-client.
Motivation to develop
- Easily browsing react components with examples to pick the most appropriate component for your current task
- Provide an always actual documentation
Usage
-
Clone repository
git clone https://github.com/OpusCapita/react-showroom-server
-
Install dependencies
npm install
-
Host and port configuration here
-
Run this goal (see configuration below)
npm run init-packages
What this goal do:
-
Remove packages installation root directory named specified here
-
Install packages list specified here
-
Scan npm packages directories to find components. Only documented components will be added. Config here
-
Make bundles using webpack configuration. Maybe you should not change it
-
Components must be available as fields of npm package main file
Roadmap
- Improve init-packages process
- Make Docker container for easy deploy and update
Contributors
- Alexey Sergeev - alexey.sergeev@opuscapita.com
- Kirill Volkovich - kirill.volkovich@opuscapita.com
License
OpusCapita 2016