Skip to content

Latest commit

 

History

History
146 lines (107 loc) · 4.81 KB

README.md

File metadata and controls

146 lines (107 loc) · 4.81 KB
Raw

Input is a no-code application to create simple & clean forms.
With our customization options, you can let the forms shine in your brands colors.

Why Input?

Input aims to be an alternative to proven tools like TypeForm, with the added benefit of self-hosting and having brandable forms out of the box.

We started Input out of a previous project called BotReach, which was already a conversational form tool, but closed-source. We plan to release a feature complete first MVP of Input in Q2 2022.

We are in an early stage of developing and some of our planned features are currently not in the codebase. You can contact us via philipp@deck9.co to get on the waitlist or if you want to contribute to the development.

Development

We are using Laravel Sail to develop Input. You need Docker already installed on your machine to run the entire app. We also recommend installing Node.JS and NPM directly on your host machine to make working with frontend assets more convenient.

Download

Clone the source of this repository with the following command:

git clone git@github.com:deck9/input.git

Configuration

Copy the .env.dev.example file to .env - the contents for the file should, in most cases, work out of the box. You may later generate and set the APP_KEY with the sail artisan key:generate command.

cp .env.example .env

Running

Make sure that your Docker agent is running. There are several steps necessary to build the app for the first time. To simplify these tasks, we have a Makefile in place. Just run the following command, and all build steps will run automatically:

make up

Webpack (Mix)

To compile the frontend assets, we use Laravel Mix. You can use watch mode to rerun Webpack each time a file changes. We also have a hot-reload enabled mode. Please note that this mode currently has a bug since we have defined multiple entry files for Webpack.

npm run dev
# or
npm run dev # hot reload enabled

Sail Bash Alias

It is recommended to create a bash alias, to make working with Laravel Sail simple as possible. To do this, you can check out the Laravel docs on this topic or just add the following alias to your .bashrc or .zshrc:

alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail'

With the alias, you can quickly perform tasks on the App Docker Container:

sail up -d # start container
sail artisan tinker # use laravel artisan commands
sail artisan db:migrate # run database migrations
sail artisan test # run phpunit
sail composer {args} # use composer

Production Deployment

Quick Start

# Create Docker Volume
docker volume create input-data

# Run the container using port 8080 on the host
docker run -d -p 8080:8080 --name input \
    -v input-data:/var/www/html/storage \
    ghcr.io/deck9/input:main

Behind a Proxy

Make sure to set the APP_URL env to the domain you want to use for your proxy.

docker run -d -p 8080:8080 --name input \
    -v input-data:/var/www/html/storage \
    -e APP_URL=https://domain.tld \
    ghcr.io/deck9/input:main

Also make sure that the proxy is configured to pass forward important request information like the scheme, host and IP.

location / {
    proxy_set_header Connection "";
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Frame-Options SAMEORIGIN;
    proxy_http_version 1.1;

    # Pass the request to the address of the docker container
    proxy_pass http://127.0.0.1:8080;
}

With MySQL

docker run -d -p 8080:8080 --name input \
    -e DB_CONNECTION=mysql \
    -e DB_DATABASE=input \
    -e DB_HOST=<MySQL-Host> \
    -e DB_USERNAME=<MySQL-User> \
    -e DB_PASSWORD=<MySQL-Password> \
    ghcr.io/deck9/input:main

Sending Emails

Setting up an SMTP email service is mandatory for some features, as team invitations or email notifications. Please use the following environment variables when running the container.

docker run -d -p 8080:8080 --name input \
    -e MAIL_MAILER=smtp \
    -e MAIL_HOST=<Mail-Host> \
    -e MAIL_USERNAME=<Mail-Username> \
    -e MAIL_PASSWORD=<Mail-Password> \
    -e MAIL_FROM_ADDRESS=<Mail-From-Address> \
    -e MAIL_FROM_NAME=<Mail-From-Name> \
    -e MAIL_PORT=1025 \
    -e MAIL_ENCRYPTION=tls \
    ghcr.io/deck9/input:main