Skip to content

Commit

Permalink
misc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Yishaq13-getnuvo committed Jul 29, 2024
1 parent b63e583 commit c326c64
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 30 deletions.
37 changes: 8 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

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

## Description

We used [msw](https://mswjs.io/) to mock the network request.
You can read more here: [Browser Integration](https://mswjs.io/docs/integrations/browser)

- The request interceptor in located in `.src/interceptors`
- Inside `.src/index.tsx` we need to start the worker before starting the application.

## Available Scripts

In the project directory, you can run:
Expand All @@ -11,36 +19,7 @@ In the project directory, you can run:
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).
2 changes: 1 addition & 1 deletion src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import ReactDOM from "react-dom/client";
import "./index.css";
import App from "./App";
import reportWebVitals from "./reportWebVitals";
import { worker } from "./interceptors/requestInterceptor";
import { worker } from "./interceptors";

worker.start().then(() => {
ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
Expand Down
File renamed without changes.

0 comments on commit c326c64

Please sign in to comment.