Skip to content

Commit d49674a

Browse files
committed
chores:
- add readme for app config, translation, styles and services - update root readme
1 parent 55d8d17 commit d49674a

File tree

4 files changed

+20
-22
lines changed

4 files changed

+20
-22
lines changed

README.md

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,44 +24,28 @@
2424

2525
- :blue_heart: Ant Design
2626

27-
- Configurable Ant theme variables out of the box
27+
- Configurable Ant theme variables out of the box. To change theme variables, go and modify/add on `craco.config.js`
2828
- Localized Ant Design Component for better multilingual support
2929

3030
- :cop: Eslint and Prettier configured with git hooks
3131

3232
- Eslint and prettier configured together for auto save format and error checks
3333
- No git commit allowed if errors and warnings are present
3434

35-
- :raised_hands: Global HTTP error and auth handler
35+
- :raised_hands: Global HTTP error and auth handler <a href="/src/services">More on</a>
3636

37-
- Custom axios middlewares to handle errors on each request by default. But If needed, custom error handling also can be done with the error details sent by the middleware
38-
- Auth Token is sent by default if present
39-
- Progressbar animation added on each HTTP request
40-
41-
- :nail_care: Styled Components
42-
43-
- Component based styling
44-
- Custom media queries with JS added as utility with accordance to Ant design breakpoints
37+
- :nail_care: Styled Components and <a href="/src/styles">More on</a>
4538

4639
- :zap: Codesplitting
4740

4841
- Native React Lazy loaded pages/components with Suspense
4942
- Custom loader animation added
5043

51-
- :capital_abcd: Multilingual
52-
53-
- By default EN and BN json files are added.
54-
- Easily add new translation in the config folder
55-
56-
- :art: Less and Bootstrap utility classes
44+
- :capital_abcd: Multilingual <a href="/src/config/translation">More on</a>
5745

58-
- For margin padding, width and many more utility classes are added and available
59-
- less loader added
46+
- :art: Less and Bootstrap utility classes <a href="/src/styles/utilities">More on</a>
6047

61-
- :rocket: Develepment scope based App config file for deployment
62-
- App can have different configs, keys for staging, dev or prod and many more
63-
- Modify and update the `.env` file to store url/key data for different scope
64-
- Don't forget to add the `.env` file on the `.gitignore`
48+
- :rocket: Develepment scope based App config file for deployment <a href="/src/config/app">More on</a>
6549

6650
## How To Use
6751

src/config/app/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Custom App config based on development scope/phase
2+
3+
- App can have different configs, keys for staging, dev or prod and many more
4+
- Modify and update the `.env` file to store url/key data for different scope
5+
- Don't forget to add the `.env` file on the `.gitignore`

src/services/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Custom HTTP Axios Service
2+
3+
- Custom axios middlewares to handle errors on each request by default. But If needed, custom error handling also can be done with the error details sent by the middleware
4+
- Auth Token is sent by default if present
5+
- Progressbar animation added on each HTTP request

src/styles/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Custom Styled Components with Antdesign
2+
3+
- Component based styling
4+
- Custom media queries with JS added as utility with accordance to Ant design breakpoints

0 commit comments

Comments
 (0)