diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index eba890f..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,105 +0,0 @@ -# Changelog - -## 5.0.0 - 2020-10-31 - -- Upgrade to Laravel 8 -- Update dependencies -- Fixed locale cookie fallback [#221](https://github.com/cretueusebiu/laravel-vue-spa/pull/221) -- Added scroll delay [#220](https://github.com/cretueusebiu/laravel-vue-spa/pull/220) -- Added redirect to intended url [#208](https://github.com/cretueusebiu/laravel-vue-spa/pull/208) -- Added middleware parameter [#124](https://github.com/cretueusebiu/laravel-vue-spa/pull/124) - -## 4.7.0 - 2020-04-09 - -- Added `routes/spa.php` and `spa` middleware for serving the frontend [#249](https://github.com/cretueusebiu/laravel-vue-spa/pull/249) -- Added controllers for user and spa view to fix route caching [#248](https://github.com/cretueusebiu/laravel-vue-spa/pull/248) - -## 4.6.0 - 2020-03-25 - -- Upgrade to Laravel 7 - -## 4.5.0 - 2019-09-29 - -- Upgrade to Laravel 6 - -## 4.4.0 - 2019-05-17 - -- Upgrade to Laravel 5.8 -- Update npm dependencies -- Added email verification -- Removed yarn.lock in favor of package-lock.json -- Fixed `laravel-mix` (HMR, versioning, build cleanup), thanks to [TemaSM](https://github.com/TemaSM) -- Removed JS polyfills, if you want to support IE11 see [laravel-mix#436](https://github.com/JeffreyWay/laravel-mix/issues/436) - -## 4.3.0 - 2018-10-21 - -- Fixed npm install -- Update fontawesome - -## 4.2.0 - 2018-10-04 - -- Upgrade to Laravel 5.7 - -## 4.1.1 - 2018-05-10 - -- Fixed oauth popup -- Fixed session expired alert -- Update npm dependencies - -## 4.1.0 - 2018-03-14 - -- Upgrade to Laravel 5.6 -- Update npm dependencies -- Enabled Mix [esModule](https://github.com/JeffreyWay/laravel-mix/pull/1526#issuecomment-373044182) by default -- Lint with eslint-plugin-vue and eslint-config-standard - -## 4.0.0 - 2018-01-23 - -- Brought back the `layout` property in pages that was removed in 3.0. By default it's set to `default` (`~/layouts/default.vue`). - -## 3.0.1 - 2018-01-22 - -- Removed middleware from routes, since they don't work when you press the back button. Now you have to use the `middleware` property in pages. - -## 3.0.0 - 2018-01-22 - -- Removed `layout` property from pages in favor of explicit layout components -- Improved middleware system, you can either define it on a route or directly on a component -- Reorganized components -- Change jwt token ttl to one day -- Fixed hot module replacement - -## 2.2.1 - 2018-01-19 - -- Upgrade to Bootstrap 4 - -## 2.2.0 - 2018-01-16 - -- Added dynamic import for pages -- Added locale with dynamic import -- Import shakable fontawesome module - -## 2.1.0 - 2018-01-10 - -- Simplifyd password reset -- Upgrade to Bootstrap 4 beta3 -- Added oauth with popup window - -## 2.0.0 - 2017-12-19 - -- Added support for Socialite -- Added dropdown to select the locale -- Added route middleware -- Added Font Awesome 5 icons -- Added user profile photo in navbar -- Added Chinese and Spanish translations -- Upgrade to Bootstrap 4 beta2 -- Fixed router scroll behaviour -- Namespaced store modules -- Published project to Packagist - -## 1.0.0 - 2017-09-02 - -- Upgrade to Laravel 5.5. -- Upgrade to Bootstrap 4 beta1. -- Rework routing and guards. diff --git a/README.md b/README.md index dd6bb00..411060e 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,52 @@ # OpnForm - - - - -> A Laravel-Vue-Tailwind SPA starter kit. Forked from [cretueusebiu/laravel-vue-spa](https://github.com/cretueusebiu/laravel-vue-spa). -
- +
+ + +> An open-source form builder. It's an alternative to products like Typeform, JotForm, Tally etc. + ## Features -- Laravel 8 -- Vue + VueRouter + Vuex + VueI18n + ESlint -- Pages with dynamic import and custom layouts -- Login, register, email verification and password reset -- Authentication with JWT -- Socialite integration -- TailwindCSS v2 +- No-code form builder, with infinite number of fields & submissions +- Text inputs, Date inputs, URL inputs, Phone inputs, Email inputs, Checkboxes, Select and Multi-Select inputs, Number Inputs, Star-ratings, File uploads & more +- Embed anywhere (on your website, in your Notion page, etc) +- Email notifications (for both form owner & form respondents) +- Hidden fields +- Form passwords +- URL form pre-fill +- Slack integration +- Webhooks +- Form logic +- Customize colors, add images or even some custom code +- Captcha form protection +- Form closing date +- Limit the number of submissions allowed -## Installation +And much more! -- `composer create-project --prefer-dist JhumanJ/laravel-vue-tailwind-spa` -- Edit `.env` and set your database connection details -- (When installed via git clone or download, run `php artisan key:generate` and `php artisan jwt:secret`) -- `php artisan migrate` -- `npm install` +## Getting started with OpnForm -## Usage +The easiest way to get started with OpnForm is with the [official managed service in the Cloud](https://opnform.com/). -#### Development +It takes 1 minute to try out the builder for free. You'll have high availability, backups, security, and maintenance all managed for you. -```bash -# Build and watch -npm run watch -``` +## Self-hosting -#### Production +This section hasn't been written yet, we need to work on this. -```bash -npm run production -``` +## Tech Stack -## Socialite +OpnForm is a standard web application built with: +- [Laravel](https://laravel.com/) PHP framework +- [Vue.js](https://vuejs.org/) front-end framework +- [TailwindCSS](https://tailwindcss.com/) -This project comes with GitHub as an example for [Laravel Socialite](https://laravel.com/docs/5.8/socialite). +## Contribute +You're more than welcome to contribute to this project. We don't have guidelines on this yet, but we will soon. In the meantime, feel free to ask [any question here](https://github.com/JhumanJ/OpnForm/discussions). -To enable the provider create a new GitHub application and use `https://example.com/api/oauth/github/callback` as the Authorization callback URL. +## License +OpnForm is open-source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version. You can find it [here](https://github.com/JhumanJ/OpnForm/blob/main/LICENSE). -Edit `.env` and set `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` with the keys form your GitHub application. - -For other providers you may need to set the appropriate keys in `config/services.php` and redirect url in `OAuthController.php`. - -## Email Verification - -To enable email verification make sure that your `App\User` model implements the `Illuminate\Contracts\Auth\MustVerifyEmail` contract. - -## Testing - -```bash -# Run unit and feature tests -vendor/bin/phpunit - -# Run Dusk browser tests -php artisan dusk -``` - -## Credits -- [cretueusebiu](https://github.com/cretueusebiu/) for creating the original [Laravel Vue SPA](https://github.com/cretueusebiu/laravel-vue-spa) -- [Tailwind Kit](https://www.tailwind-kit.com/) for all their Tailwind templates - -## Changelog - -Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. diff --git a/public/img/social-preview.png b/public/img/social-preview.png index b16bd3e..d35c1cb 100644 Binary files a/public/img/social-preview.png and b/public/img/social-preview.png differ