OpusCapita/react-showroom-client

Aggregate documentation service (draft)

Closed this issue · 1 comments

Think about new project which aggregates multiple projects instead of support @opuscapita/react-showroom-server.

Server side:

  • Config example
{
  polling: true,
  pollingInterval: 60, // minutes
  projects: {
    'react-dates-master': {
      repositoryUrl: 'https://github.com/OpusCapita/react-dates',
      repositoryType: 'git',
      branch: 'master',
      installCommand: 'npm install'
      runCommand: 'npm start'
    },
    ...
  }
}
  • REST API (draft)

    • GET /projects

    • GET /project/:id

    • PUT /project/:id

    • DELETE /project/:id

    • POST /project/run/:id

    • POST /project/stop/:id

    • POST /project/restart/:id

    • POST /project/reinstall/:id

    • POST /project/refetch/:id

Layout:

  • At sidebar - links to running demo pages.

    Should display status (run, stop, run-error)
    Should contanin control (run, stop, run-error)

  • At right side - markdown content of project info files: README.md, CHANGES.md, etc.

Stale. Closing.