Git Product home page Git Product logo

openhospital-ui's Introduction

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:

Used for async HTTP calls

Used for testing

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

In order to change page headers

For internationalization

openhospital-ui's People

Contributors

almeida1492 avatar xrmx avatar acegentile avatar mwithi avatar alefalezza avatar mrqwenty avatar pviotti avatar simobasso avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.