Skip to content

Commit

Permalink
Fix frontend, backend readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
choidabom committed Oct 9, 2024
1 parent d8aa32f commit a698b51
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,31 +51,31 @@ You can access the Swagger-based REST API specification at `<API_URL>/api` when
### Building the Project:

```bash
pnpm run build
pnpm backend build
```

Builds the project.

### Linting the Code:

```bash
pnpm run lint
pnpm backend lint
```

Lints TypeScript files using ESLint. Fixes any fixable linting errors.

### Testing:

```bash
pnpm test
pnpm backend test
```

Runs unit tests using Jest.

### Running in Production:

```bash
pnpm start
pnpm backend start
```

Starts the server in production mode.
Expand Down
12 changes: 6 additions & 6 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,47 +47,47 @@ This project is the frontend part of the CodePair service developed using Vite a
### Running the Development Server:

```bash
pnpm run dev
pnpm frontend dev
```

Starts the development server using Vite.

### Building the Project:

```bash
pnpm run build
pnpm frontend build
```

Compiles TypeScript files (`tsc`) and builds the project using Vite.

### Linting the Code:

```bash
pnpm run lint
pnpm frontend lint
```

Lints TypeScript and TypeScript React files using ESLint. Reports any linting errors or warnings.

### Previewing the Production Build:

```bash
pnpm run preview
pnpm frontend preview
```

Previews the production build of the project using Vite.

### Formatting the Code:

```bash
pnpm run format
pnpm frontend format
```

Formats the code using Prettier according to project configurations. Automatically fixes any formatting issues.

### Checking Code Formatting:

```bash
pnpm run format:check
pnpm frontend format:check
```

Checks if the code is formatted correctly according to Prettier configurations. Reports any formatting issues without fixing them.
Expand Down

0 comments on commit a698b51

Please sign in to comment.