Finally, good open-source forms!
Website & Hosted version | Join Discord community
⚠️ Note: This repository is still in an early stage of development. We love the open source community and want to show what we are working on early. We will update this readme with more information once it is safe to use. Until then, feel free to share your thoughts, contact us, and contribute if you'd like.
Spin up forms in minutes. Pipe your data exactly where you need it. Maximize your results with juicy analytics.
The snoopHub is the heart of snoopForms. In it, all form submissions are processed, analyzed, forwarded and you can even build your own forms with the help of the no-code editor.
If you prefer to build your forms completely customizable and send the submissions directly to snoopHub, check out our React library.
- React Lib & No Code Builder to build & integrate forms rapidly.
- 100% compliant with all privacy regulations (self-hosted).
- (next) Put your data to work with integrations.
- (next) Juicy analytics out of the box.
- (always) smooth Developer Experience comes first.
To get the project running locally on your machine you need to have the following development tools installed:
- Node.JS (we recommend v16)
- Yarn
- PostgreSQL
- Clone the project:
git clone https://github.com/snoopForms/snoopforms.git && cd snoopforms
- Install Node.JS packages via yarn. Don't have yarn? Use
npm install --global yarn.
yarn install
- Make sure you have a running database instance, e.g. by using docker. A quick and dirty instance can be spun up via:
docker run --name snoopformsDB -p 5432:5432 -e POSTGRES_USER=snoopforms -e POSTGRES_PASSWORD=password -e POSTGRES_DB=snoopforms -d postgres
- Create a
.envfile based on.env.exampleand change it according to your setup. Make sure theDATABASE_URLvariable is set correctly according to your local database. For the signup process, an email server with valid SMTP data is necessary.
cp .env.example .env
For the example above, use the following:
DATABASE_URL='postgresql://snoopforms:password@localhost:5432/snoopforms?schema=public'
-
Use the code editor of your choice to edit the .env file. You need to change all fields according to your setup. The SMTP-credentials are essential for verification emails to work during user signup.
-
Make sure your PostgreSQL Database Server is running. Then let prisma set up the database for you:
yarn prisma migrate dev
- Start the development server:
yarn dev
You can now access the app on https://localhost:3000. You will be automatically redirected to the login. To use your local installation of snoopForms, create a new account.
The easiest way to deploy the snoopHub on your own machine is using Docker. This requires Docker and the docker compose plugin on your system to work.
Clone the repository:
git clone https://github.com/snoopForms/snoopforms.git && cd snoopforms
Create a .env file based on .env.example and change all fields according to your setup. The SMTP-credentials are essential for verification emails to work during user signup.
cp .env.example .env && nano .env
Start the docker compose process to build and spin up the snoopForms container as well as the postgres database.
docker compose up -d
You can now access the app on https://localhost:3000. You will be automatically redirected to the login. To use your local installation of snoopForms, create a new account.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Make your changes
- Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
Distributed under the AGPLv3 License. See LICENSE for more information.