Skip to content

updating read me #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 2, 2024
Merged

updating read me #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 27 additions & 21 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ This documentation provides detailed instructions on how to set up the **Genpod*

The project consists of three main parts:

* React application using Vite
* File server
* Socket server
* React application using Vite
* File server
* Socket server

## Prerequisites

* Node.js (>= 14.x)
* Yarn package manager
* Node.js (>= 14.x)
* Yarn package manager

## Step-by-Step Setup

Expand Down Expand Up @@ -194,28 +194,34 @@ The `socket-server` should now be running at `http://localhost:3002`.

### React Application Scripts

* `yarn dev-cy` - Install Cypress and run the development server and coverage report.
* `yarn dev` - Run the development script located at `scripts/dev.sh`.
* `yarn build` - Compile TypeScript and build the Vite project.
* `yarn lint` - Lint the project files.
* `yarn clean-dev` - Clean node_modules, reinstall dependencies, and run the development server.
* `yarn preview` - Preview the built project.
* `yarn storybook` - Start Storybook for UI component development.
* `yarn build-storybook` - Build the Storybook static site.
* `yarn cy-install` - Install Cypress.
* `yarn cy:open-e2e` - Open Cypress for end-to-end testing.
* `yarn cy:open-unit` - Open Cypress for unit testing.
* `yarn cy:run-e2e` - Run Cypress end-to-end tests.
* `yarn cy:run-unit` - Run Cypress unit tests.
* `yarn coverage-open` - Run unit tests and serve the coverage report.
* `yarn dev-cy` - Install Cypress and run the development server and coverage report.
* `yarn dev` - Run the development script located at `scripts/dev.sh`.
* `yarn build` - Compile TypeScript and build the Vite project.
* `yarn lint` - Lint the project files.
* `yarn clean-dev` - Clean node_modules, reinstall dependencies, and run the development server.
* `yarn preview` - Preview the built project.
* `yarn storybook` - Start Storybook for UI component development.
* `yarn build-storybook` - Build the Storybook static site.
* `yarn cy-install` - Install Cypress.
* `yarn cy:open-e2e` - Open Cypress for end-to-end testing.
* `yarn cy:open-unit` - Open Cypress for unit testing.
* `yarn cy:run-e2e` - Run Cypress end-to-end tests.
* `yarn cy:run-unit` - Run Cypress unit tests.
* `yarn coverage-open` - Run unit tests and serve the coverage report.

### File Server Scripts

* `yarn dev` - Start the file server using `nodemon`.
* `yarn dev` - Start the file server using `nodemon`.

### Socket Server Scripts

* `yarn dev` - Start the socket server using `ts-node`.
* `yarn dev` - Start the socket server using `ts-node`.

### Spin up dummy llm agent

```bash
cd dummy-llm-agent && yarn && yarn dev
```

## Conclusion

Expand Down