Skip to content

Commit aa2da52

Browse files
authored
Update README.md
1 parent 40d665f commit aa2da52

File tree

1 file changed

+40
-36
lines changed

1 file changed

+40
-36
lines changed

README.md

Lines changed: 40 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,52 @@
1-
# Advanced React For Enterprise: React for Senior Engineers
1+
# Advanced React For Enterprise
22

3+
**Developed By:** Eranda Samarasinghe
4+
<hr />
5+
6+
## Project Backgroud and Overview
37
This repository contains resources and examples for the "Advanced React For Enterprise: React for Senior Engineers" course from Udemy. The course covers advanced topics in React, including performance optimization, state management, and server-side rendering.
8+
<hr />
9+
10+
## Project Goals
11+
The main objectives of this application are to:
412

5-
## Table of Contents
13+
1. This project focuses on implementing scalable CSS architecture for maintainable and consistent styles.
14+
2. It designs reusable React components using effective design patterns for modularity and composability.
15+
3. The components are built with TypeScript to ensure type safety and improve code maintainability.
16+
4. Unit and visual regression testing are incorporated to maintain component stability and catch layout or style issues.
17+
5. Storybook is used to document components and establish a consistent design system for collaboration.
18+
<hr />
619

7-
- [Installation](#installation)
8-
- [Usage](#usage)
9-
- [NPM Packages](#npm-packages)
10-
- [Contributing](#contributing)
20+
## Technical Details
21+
Core technologies used:
22+
23+
- **React.js, JavaScript, TypeScript, SCSS, HTML**
24+
<hr />
1125

1226
## Installation
27+
1. Clone repository:
28+
```sh
29+
git clone https://github.com/dev-eranda/reactjs-design-system-engineer
30+
31+
2. Build the project:
32+
```sh
33+
npm run build
1334
14-
To get started, clone this repository and install the dependencies:
15-
```bash
16-
git clone https://github.com/yourusername/ds.e.git
17-
cd ds.e
18-
npm install
19-
```
35+
3. Start development server:
36+
```sh
37+
npm start
2038

21-
## Usage
22-
Build the project:
23-
```bash
24-
yarn build
25-
```
26-
Start the development server:
27-
```bash
28-
yarn dev
29-
```
30-
Test the project:
31-
```bash
32-
yarn test
33-
```
34-
Publish the project:
35-
```bash
36-
yarn publish
37-
```
38-
Commit the project:
39-
```bash
40-
yarn commit
41-
```
39+
4. Test the project:
40+
```sh
41+
npm test
4242
43+
5. Publish the project:
44+
```sh
45+
npm publish
4346

47+
6. Commit the project:
48+
```sh
49+
yarn commit
4450
4551
## NPM Packages
4652
@test.ds.e/foundation
@@ -56,6 +62,4 @@ npm install @test.ds.e/react
5662
npm install @test.ds.e/scss
5763
```
5864

59-
## Contributing
60-
Contributions are welcome! Please open an issue or submit a pull request.
61-
65+
- **Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.**

0 commit comments

Comments
 (0)