fredoist / typiform

Typiform

Easy online form builder that works like a doc. Just add form elements as you type and start collecting data.
Read article on Hashnode »

View Demo · Report Bug · Request Feature

About The Project

Built With

• React + Next.js
• Tailwind CSS
• Auth0
• HarperDB
• Jotai

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/fredoist/typiform.git

2. Install NPM packages

   npm install

3. Create a .env.local file and add your own variables

   # HarperDB
   HARPERDB_TOKEN=[Your HarperDB Authorization Token]
   HARPERDB_URL=https://example.harperdbcloud.com
   
   # Unsplash
   UNSPLASH_TOKEN=[Your Unsplash Access Key]
   UNSPLASH_API=https://api.unsplash.com
   
   # Auth0
   AUTH0_SECRET=[use [openssl rand -hex 32] to generate a 32 bytes value]
   AUTH0_BASE_URL=https://example.com
   AUTH0_ISSUER_BASE_URL=https://example.us.auth0.com
   AUTH0_CLIENT_ID=[Your Auth0 Client ID]
   AUTH0_CLIENT_SECRET=[Your Auth0 Client Secret]

4. On harperdb you must create a schema named typiform and create the following tables

   • forms to store form data
   • responses to store form response data

5. Run your local dev server by running npm run dev

Screenshots

Landing Page

Form Editor

Unsplash Integration

Dashboard Page

Viewform Page

For more, please refer to the Hashnode Article

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to 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. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

Freddy González - @fredoist

Project Link: https://github.com/fredoist/typiform