Skip to content

Commit

Permalink
Releases v1
Browse files Browse the repository at this point in the history
  • Loading branch information
Midnight-Coder committed Oct 16, 2021
1 parent ef2721b commit 51284c3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 8 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# React Gold

Skeleton SPA ready for production.
Tech Stack: React, Redux, Redux-Saga, Material-UI, React Testing Library, Jest, ESLint, Docker, CircleCI
Skeleton SPA; ready for production.

Tech Stack: React, [Synthetic-Redux (Redux + Redux-Saga)](https://www.npmjs.com/package/synthetic-redux), Material-UI, React Testing Library, Jest, ESLint, Docker, CircleCI

[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

Expand All @@ -13,10 +17,10 @@ Open [http://localhost:4140](http://localhost:4140) to view it in the browser.

### Code organization

1. urlConstants -> API endpoints organized as export consts per application feature
2. redux: Types -> typically you'd need a FETCH_x, FETCH_x_SUCCESS, FETCH_x_ERROR
3. redux: Action generators, Reducers & Saga
4. /pages -> Each feature is an app directory. The page handles the API communication & error handling
1. apiUrls.js -> API endpoints organized as `exported consts` per application feature
2. redux: Types.js - 1 action type per action (synthetic redux dynamically creates error and success type)
3. /pages -> Each feature is an app directory. The page handles the API communication & error handling
4. /pages/<page>.redux.js -> Synthetic Redux configuration for the page
5. /components -> Each feature has multiple pure components orchestrated by one pure component
6. /components/common -> Common ReactJS components
7. Theme.js -> Material UI Opinions & Overrides
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-gold",
"version": "0.2.0",
"version": "1.0.0",
"private": true,
"dependencies": {
"@material-ui/core": "^4.10.2",
Expand Down
2 changes: 1 addition & 1 deletion src/pages/SampleApp/SamplePage.redux.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { combineReducers } from 'redux';
import { all } from 'redux-saga/effects';
import { SAMPLE } from 'redux/Types';
import { SyntheticRedux } from 'synthetic-redux';
import sample from 'utils/urlConstants';
import sample from 'utils/apiUrls';


const fetchSampleStatus = new SyntheticRedux({
Expand Down
File renamed without changes.

0 comments on commit 51284c3

Please sign in to comment.