https://github.com/opuscapita/react-showroom-server

Server side and tools to be used together wtih '@opuscapita/react-showroom-client'
https://github.com/opuscapita/react-showroom-server

Last synced: 4 months ago
JSON representation

Server side and tools to be used together wtih '@opuscapita/react-showroom-client'

• Host: GitHub
• URL: https://github.com/opuscapita/react-showroom-server
• Owner: OpusCapita
• License: apache-2.0
• Created: 2016-11-25T10:44:47.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-05-07T13:13:32.000Z (over 5 years ago)
• Last Synced: 2025-03-18T11:48:36.301Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 68.4 KB
• Stars: 0
• Watchers: 61
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Node - Showroom Server

[![CircleCI Status](https://circleci.com/gh/OpusCapita/react-showroom-server/tree/master.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/OpusCapita/react-showroom-server)

![badge-npm-version](https://img.shields.io/npm/v/@opuscapita/react-showroom-server.svg)

[![NPM Downloads](https://img.shields.io/npm/dm/@opuscapita/react-showroom-server.svg)](https://npmjs.org/package/@opuscapita/react-showroom-server)

![badge-license](https://img.shields.io/github/license/OpusCapita/react-showroom-server.svg)

## Synopsis

Server side for [@opuscapita/react-showroom-client](https://github.com/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

  ```shell

  git clone https://github.com/OpusCapita/react-showroom-server

  ```

* Install dependencies

  ```shell

  npm install

  ```

* Host and port configuration [here](./serverConfig.js)

* Run this goal (see configuration below)

  ```shell

  npm run init-packages

  ```

### What this goal do:

  * Remove **packages installation root** directory named specified [here](./src/tools/npm-installer/config.js)

  * Install **packages list** specified [here](./src/tools/npm-installer/config.js)

  * Scan npm packages directories to find components. Only documented components will be added. Config [here](./src/tools/npm-scanner/config.js)

  * Make bundles using [webpack configuration](./src/tools/npm-bundler/webpack.config.js). **Maybe you should not change it**

  * Components **must** be available as fields of [npm package main file](https://docs.npmjs.com/files/package.json#main)

## Roadmap

* Improve init-packages process

* Make Docker container for easy deploy and update

## Contributors

* Alexey Sergeev - [alexey.sergeev@opuscapita.com](alexey.sergeev@opuscapita.com)

* Kirill Volkovich - [kirill.volkovich@opuscapita.com](kirill.volkovich@opuscapita.com)

## License

OpusCapita 2016