1
0
ohmyform/README.md

114 lines
5.1 KiB
Markdown
Raw Normal View History

![OhMyForm](public/logo.png)
2020-06-09 02:55:19 -07:00
# OhMyForm
2015-06-29 15:51:29 -07:00
2020-06-09 02:55:19 -07:00
![Project Status](https://badgen.net/github/checks/ohmyform/ohmyform)
![Latest Release](https://badgen.net/github/tag/ohmyform/ohmyform)
2020-06-11 01:42:01 -07:00
[![Docker Pulls](https://badgen.net/docker/pulls/ohmyform/ohmyform)](https://hub.docker.com/r/ohmyform/ohmyform)
2020-06-09 02:55:19 -07:00
[![Lokalise](https://badgen.net/badge/Lokalise/EN/green?icon=libraries)](https://app.lokalise.com/public/379418475ede5d5c6937b0.31012044/)
![Last Commit](https://badgen.net/github/last-commit/ohmyform/ohmyform)
2019-07-11 16:45:55 -07:00
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/ohmyform/ohmyform/tree/master)
2019-07-11 16:45:55 -07:00
2023-10-13 10:49:50 -07:00
[Demo](https://demo.ohmyform.org/) Username and password are just `demo`. We will reset the demo instance at least once for every new release and possibly more often so don't rely on it for sending actual forms expect no notice for resets.
2020-06-11 03:15:31 -07:00
2020-06-09 02:55:19 -07:00
> An *open source alternative to TypeForm* that can create stunning mobile-ready forms, surveys and questionnaires.
[![Discord](https://img.shields.io/discord/595773457862492190.svg?label=Discord%20Chat)](https://discord.gg/MJqAuAZ)
[![Financial Contributors on Open Collective](https://opencollective.com/ohmyform-sustainability/all/badge.svg?label=financial+contributors)](https://opencollective.com/ohmyform-sustainability)
2019-07-11 16:59:03 -07:00
## Table of Contents
2019-07-11 16:45:55 -07:00
<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
2020-06-09 02:55:19 -07:00
- [OhMyForm](#ohmyform-091)
2019-07-11 16:45:55 -07:00
- [Table of Contents](#table-of-contents)
- [Features](#features)
2021-05-02 07:26:28 -07:00
- [On the Roadmap](#on-the-roadmap)
2019-07-11 16:45:55 -07:00
- [How to Contribute](#how-to-contribute)
- [Quickstart](#quickstart)
- [Where to get help](#where-to-get-help)
<!-- /TOC -->
2019-07-11 16:59:03 -07:00
## Features
2019-07-11 16:45:55 -07:00
2021-05-02 07:26:28 -07:00
- Multi-Language Support
2019-07-11 16:45:55 -07:00
- 11 possible question types
- Editable start and end pages
- Export Submissions to XLS, JSON or CSV
- Native Analytics and Google Analytics Support
- Embeddable Forms
- Forms as a Service API
2021-05-02 07:26:28 -07:00
- Customizable Notifications on Form Submission
- Web Hooks on Form Submission
- Deployable with Heroku and DockerHub
- PostgreSQL and sqlite
2019-07-11 16:45:55 -07:00
2019-10-09 07:43:30 -07:00
<!-- TODO: Determine roadmap for OhMyForm if it is to be different from OhMyForm's roadmap. -->
<!-- ### On the Roadmap (Tentative pending [refactor](https://github.com/ohmyform/ohmyform/pull/1)) -->
2021-05-02 07:26:28 -07:00
### On the Roadmap
- Custom Subdomains for each User
2019-07-11 16:45:55 -07:00
- Implement encryption for all form data
- Add Typeform API integration
2022-06-09 01:03:09 -07:00
- Add plugin/3rd party integration support (aka Slack)
2019-07-11 16:45:55 -07:00
- Create wiki for easy installation and setup
- Add Stripe/Payment Form field
- Add Custom Background and Dropdown Field Images
- Add File Upload Form Field
2019-10-09 07:43:30 -07:00
<!-- TODO: add a CONTRIBUTING.md. -->
2019-07-11 16:59:03 -07:00
## How to Contribute
2017-04-22 16:27:06 -07:00
2019-10-31 09:39:15 -07:00
Please checkout our [contributing guide](CONTRIBUTING.md) on ways to contribute to OhMyForm.
2015-11-23 11:19:02 -08:00
2019-07-11 16:59:03 -07:00
## Quickstart
2015-11-23 13:06:02 -08:00
Follow documentation hosted on [OhMyForm.com](http://ohmyform.com/docs/install/) it will be the main and hopefully only location to obtain the up to date documentation.
2015-11-23 13:06:02 -08:00
2022-06-09 01:03:09 -07:00
If you pull the repository do not forget to execute: `git submodule update --init`
2020-06-03 05:17:16 -07:00
2021-05-02 07:26:28 -07:00
### Some technical Insights
[API](https://github.com/ohmyform/api/tree/master/doc)
[UI](https://github.com/ohmyform/ui/tree/master/doc)
2019-07-11 16:59:03 -07:00
## Where to get help
2015-06-29 15:51:29 -07:00
[![Discord](https://img.shields.io/discord/595773457862492190.svg?label=Discord%20Chat)](https://discord.gg/Y2TTePM)
2016-07-20 18:55:51 -07:00
2019-10-10 11:21:16 -07:00
## Alternative Social
[Twitter](https://twitter.com/OhMyForm)
[Instagram](https://www.instagram.com/ohmyform/)
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
[![Contributors](https://opencollective.com/ohmyform-sustainability/contributors.svg?width=890&button=false)](https://github.com/ohmyform/ohmyform/graphs/contributors)
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/ohmyform-sustainability/contribute)]
#### Individuals
2021-05-02 07:26:28 -07:00
[![Individuals](https://opencollective.com/static/images/opencollective-og-default.png)](https://opencollective.com/ohmyform-sustainability)
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/ohmyform-sustainability/contribute)]
[![](https://opencollective.com/ohmyform-sustainability/organization/0/avatar.svg)](https://opencollective.com/ohmyform-sustainability/organization/0/website)
[![](https://opencollective.com/ohmyform-sustainability/organization/1/avatar.svg)](https://opencollective.com/ohmyform-sustainability/organization/1/website)
[![](https://opencollective.com/ohmyform-sustainability/organization/2/avatar.svg)](https://opencollective.com/ohmyform-sustainability/organization/2/website)
2021-05-02 07:26:28 -07:00
[![](https://opencollective.com/ohmyform-sustainability/organization/3/avatar.svg)](https://opencollective.com/ohmyform-sustainability/organization/2/website)
[![](https://opencollective.com/ohmyform-sustainability/organization/4/avatar.svg)](https://opencollective.com/ohmyform-sustainability/organization/2/website)
[![](https://opencollective.com/ohmyform-sustainability/organization/5/avatar.svg)](https://opencollective.com/ohmyform-sustainability/organization/2/website)