Skip to content

docs: add prerequisites to Development section #277

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
alexgrozav merged 1 commit into from
Jun 24, 2026
Merged

docs: add prerequisites to Development section #277

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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,20 +173,33 @@ Looking for advanced features? Check out [Styleframe Pro](https://styleframe.dev

## Development

### Prerequisites

- [Node.js](https://nodejs.org/) v22.0.0 or higher
- [pnpm](https://pnpm.io/) v10.7.1 or higher

### Getting Started

```bash
# Clone the repository
git clone https://github.com/styleframe-dev/styleframe.git
cd styleframe

# Install dependencies
pnpm install

# Run tests
pnpm test

# Build
# Build all packages
pnpm build

# Start development server (docs + storybook)
pnpm dev:docs
```

See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed contribution guidelines.

## License

Styleframe is [MIT licensed](https://github.com/styleframe-dev/styleframe/blob/main/LICENSE).
Expand Down
Loading