Breadboard is a tool for creating and sharing simple flowcharts. Built with Next.js and bootstrapped with create-next-app.
First, run the development server:
npm run dev # Start development server with Turbopack
npm run build # Build for production
npm run start # Start production server
npm run lint # Run ESLint
npm run format # Format code with PrettierOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.
- Create interactive flowcharts with places and affordances
- Real-time editing of node labels and content
- Automatic connection handling between nodes
- Local storage persistence
- Dark mode support
- Responsive design
- Next.js - React framework
- React Flow - Flowchart library
- Tailwind CSS - Styling
- TypeScript - Type safety
- Prettier - Code formatting
- ESLint - Code linting
The project uses several custom fonts:
- Kalam for the main content
- Geist Mono for code and technical content
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
We welcome contributions! Please read our CONTRIBUTING.md guide to learn about our development process and requirements.
Note: All pull requests with visual changes must include before & after screenshots.
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
- ✅ You can use this software for any purpose
- ✅ You can modify the source code
- ✅ You can distribute your modifications
⚠️ If you modify and run this software as a network service (like a web app), you must make your modified source code available to users⚠️ Any modifications must also be licensed under AGPL-3.0
This license ensures that any improvements to Breadboarding remain open and available to the community, even when used as a service.
See the LICENSE file for the full license text.
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.