clean-architecture-react-boilerplate

KO | EN

gitlite — search

#python #javascript #java #php #django #ruby #wordpress #dotfiles #c-plus-plus #html #lua #docker

clean-architecture-react-boilerplate

★ 33 Open GitHub ↗

Clean Architecture boilerplate for React.js

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Clean Architecture React Boilerplate

### DESCRIPTION

This repository is a real life example of Clean Architecture with use of `React.js` and `Typescript`

TODO DIAGRAM

##### Technologies used

1. `Typescript` ( `v3.9.3` )
2. `Inversify.js`
3. `GraphQL`
4. `React.js`

##### Structure

1. ui

Contains definition of presentation layer like controller, express setup etc  
        
2. domain
    
        Contains definition of use cases, DTO's, contracts for repositories
        
3. data

Contains definition of data sources
        
4. ioc ( `Dependency injection layer` )
        
        Contains definition for Container and whole project dependencies
        
##### What is supported?

TODO

##### Reference

TODO

### PREREQUISITIES

* `Yarn`

### SETUP

TODO
       
### HOW TO RUN LOCALLY

1. Follow `SETUP` section first and install `PREREQUISITIES`
2. `Yarn install` - installing dependencies
3. `Yarn start` - run app
       
### TESTING

TODO

#### Mutational Testing

TODO

### APPLIED CONCEPTS

There are some universal concepts in programming ( designed patterns ) which are common for general engineering but
it's not always obvious how to use environment specific concepts. In this boilerplate I'm going to show how to handle that.

#### Request Object

Request object defines parameters / input to specific module input ( domain / infrastructure ), and holds
required data which cannot be changed on the fly.

#### Mocking

TODO

#### Mapper

Simple concept where one module data structure is translated to another module

##### Data -> Domain Mapper

TODO

##### Domain -> UI Mapper

TODO

#### Seeds

Used for local development or testing - it's just data for specific use cases which can be also used for dev
environment where QA's can test specific endpoints or screens. It's also useful as start data for local development 
especially when you are working as a full stack.

#### Tests parallelization

TODO

#### Mutational testing

TODO

#### Integration testing

TODO

### STILL TODO

* Provide infrastructure diagram
* Provide example of marionette testing with use of react-testing-library ( alternative to enzyme )
* Provide example of mutational testing with react
* Provide example of BDD integration with cucumber use and Cypress
* Provide few examples of UI testing
* Provide examples how to group tests by tags in Cucumber
* Introduce Kubernetes
* Introduce docker
* Introduce way of thinking understood as `Data Space` which will simplify data and content management across specific
  screen
* Introduce and explain communication between screen with `Data Space` and nested widgets
* Introduce more abstract way of `dataStore` integration ( OPTIONAL ) 
* Add CHANGELOG v1 when boilerplate is finished
* Provide example of handling errors ( api error, component error )
* Apply animations
* Extend mocking switch to live response editor request preview, delay etc
* Extend routing examples to handle authenticated routes, role routes etc

### KNOWN ISSUES

* Recoil is in experimental state, so you may notice some console errors - [Issue link](https://github.com/facebookexperimental/Recoil/issues/12)

clean-architecture-react-boilerplate

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README