sirawats/couchforms

An Open-Sourve alternative to Typeform and Microsoft Forms

couchforms

An Open-Source alternative to Typeform and Microsoft Forms
Website | Join slack community

About Couchforms

Are you looking for a modern open source survey & forms platform that keeps your participants' data private and secure? We are building a new & open user experience with a focus on privacy, usability and API-first integrability.

Features

• Easy creation of surveys and forms
• Simple evaluation of the results and export of the answers as CSV
• Rest API for integration into existing systems and processes
• Form/Survey customization

Built With

• Typescript
• Next.js
• React
• TailwindCSS
• Prisma

Getting started

To get the project running locally on your machine you need to have the following development tools installed:

• Node.JS
• Yarn
• PostgreSQL

1. Clone the project:

git clone https://github.com/couchforms/couchforms.git && cd couchforms

2. Install Node.JS packages:

yarn install

3. Create a .env file based on .env.examples and change it according to your setup. Make sure the DATABASE_URL variable is set correctly according to your local database. You must also set the email variables to valid SMTP-credentials for the login to work.

cp .env.example .env && nano .env

4. Let prisma set up the database for you:

npx prisma db push

5. Start the development server:

yarn dev

You can now access the app on https://localhost:3000

Deployment

The easiest way to deploy couchforms yourself on your own machine is using Docker. This requires Docker and docker-compose on your system to work.

Clone the repository:

git clone https://github.com/couchforms/couchforms.git && cd couchforms

Create a .env file based on .env.examples and change it according to your setup. You must set the email variables to valid SMTP-credentials for the login to work:

cp .env.example .env && nano .env

Start the docker-compose process to build and spin up the couchforms container as well as the postgres database.

docker-compose up -d

You can now access the app on https://localhost:3000

Contributing

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.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Make your changes
4. Commit your changes (git commit -m 'Add some AmazingFeature')
5. Push to the branch (git push origin feature/AmazingFeature)
6. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.