https://github.com/formscale/formscale
The most powerful open-source form builder & management tool.
https://github.com/formscale/formscale
Last synced: 11 months ago
JSON representation
The most powerful open-source form builder & management tool.
- Host: GitHub
- URL: https://github.com/formscale/formscale
- Owner: Formscale
- License: mit
- Created: 2025-01-31T07:53:01.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-05T18:52:45.000Z (12 months ago)
- Last Synced: 2025-03-05T19:33:50.888Z (12 months ago)
- Language: TypeScript
- Homepage: https://formscale.dev
- Size: 3.59 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Formscale
The most powerful form builder for any site.
## Table of Contents
- [Features](#features)
- [Project Structure](#project-structure)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [Pull Requests](#pull-requests)
- [License](#license)
## Features
- Create usable forms in seconds
- Hosted forms for static sites
- Form UI templates
- Send email notifications, connect webhooks, & integrate with CRMs
- Custom field validation, bot protection, and file upload/storage
- Cooler features
- Multi-step forms
- Form success & redirects
- Editable email templates
- Cookies & UTM tracking
- Exportable data
- React SDK for form templates & validation (future)
## Project Structure
- `frontend` - Next.js app
- `api` - Workers API
- `packages/*` - Shared packages
- `types/*` - Shared types
- `ui/*` - UI components
- `templates/*` - UI templates
- `utils/*` - Shared utilities
- `cli` - CLI for managing Formscale
- `react` - React SDK
## Getting Started
1. Clone repository:
```bash
git clone https://github.com/Formscale/formscale.git
```
2. Install dependencies:
```bash
pnpm install
```
3. Generate Prisma client:
```bash
pnpm generate
```
4. Build packages:
```bash
pnpm build
```
5. Start development servers:
```bash
pnpm dev
```
6. Configure environment:
- Add your own bucket and database from Cloudflare to `api/wrangler.toml`.
- Add your own Resend API key and JWT secret to `api/.dev.vars.example` and rename it to `.dev.vars`.
## Usage
WIP
## Contributing
Contributions are welcome! Please feel free to [open an issue](https://github.com/Formscale/formscale/issues) or submit a [pull request](https://github.com/Formscale/formscale/pulls).
DM on Discord for questions (dris404).
Planning to launch end of Feb 2025?
### Pull Requests
1. Create a feature branch:
```bash
git checkout -b feature/new-feature
```
2. Make changes and commit:
```bash
git commit -m "feat: added new feature"
git commit -m "fix: fixed bug with..."
git commit -m "docs: updated readme"
```
3. Run checks before pushing:
```bash
pnpm lint # lint
pnpm build # see if it builds
pnpm test # run tests
```
4. Push and create PR:
```bash
git push origin feature/new-feature
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.