Formeo is open source to the core and contributions are always welcome. In this document we'll cover some dependencies and installation process to get your local development environment up and running.
If you're having trouble please don't hesitate to open Issue here
To develop for Formeo you'll need:
- Node.js 22.12 or newer (the floor both Vite and
npm test's native test runner support)
While not required, the following tools are recommended to maintain code quality and consistency in style.
- Biome - Fast formatter and linter for JavaScript, TypeScript, and JSON
Navigate to the directory you'll be working from and run:
git clone https://github.com/Draggable/formeo.git
cd formeo
npm install
npm start
The above code will clone the repo, install the required node_modules and run the npm start task (a Vite dev server). You should now have a locally running version of the demo accessible at http://localhost:5173/.
npm test # unit tests (Node.js native test runner)
npm run playwright:test # e2e tests
Lefthook runs automatically:
- pre-commit: Biome linting/formatting on staged files
- commit-msg: validates the commit message follows Conventional Commits
- pre-push: the full test suite (
npm test)
Windows users, remember to configure your line endings with core.autocrlf. More info here
$ git config --global core.autocrlf true
# Configure Git on Windows to properly handle line endings