/openhospital-ui

OpenHospital software SPA (Single Page Application) for the User Internface (React)

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

React starter template by Intesys

This boilerplate is generated using Create React App with the Typescript preset and contains the libraries and guidelines defined by Intesys.

You can read the original README here

Quickstart

Use npm install to install dependencies.

  • npm run start, runs the app in development mode. Open http://localhost:3000 to view it in the browser.
  • npm run test, runs the tests
  • npm run api, runs the api backend via openapi-server command
  • npm run start:api, runs concurrently the api server and the ui
  • npm run build, builds the ui
  • npm run coverage, run tests with coverage

Guidelines

Folder structure

Basic folder structure:

build/dist/
public/
src/
    assets/
        // put here the static assets
    config/
        // configuration files
    modules/
        // one folder per module / container
    shared/
        // shared components and libraries
    types/
        // shared types definitions
        // (local type definitions are allowed inline)
    App.tsx
    index.ts
    routes.tsx

Module structure:

[moduleName]/
    ContainerName.tsx
    ContainerName.test.jsx
    LocalComponentName.tsx
    LocalComponentName.test.tsx

Conventions

Modules follow the Duck convention.

Test: use Jest + Enzyme [ TODO: add details ]

Libraries

This boilerplate includes the following libraries, that you should use for preference:

Axios

Used for async HTTP calls

Jest

Used for testing

OpenAPI-server

Nodejs local api proxy with mocks and (optional) validation over openApi

React-helmet

In order to change page headers

React-intl & react-intl-extract

For internationalization

Appendix