README.md 2.72 KB
Newer Older
John Molakvoæ's avatar
John Molakvoæ committed
1
# Nextcloud Forms
2

John Molakvoæ's avatar
John Molakvoæ committed
3
4
5
![Downloads](https://img.shields.io/github/downloads/nextcloud/forms/total.svg?style=flat-square)
[![Code coverage](https://img.shields.io/codecov/c/github/nextcloud/forms.svg?style=flat-square)](https://codecov.io/gh/nextcloud/forms/)
[![Dependabot status](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg?longCache=true&style=flat-square&logo=dependabot)](https://dependabot.com)
6
[![Start contributing](https://img.shields.io/github/issues/nextcloud/forms/good%20first%20issue?color=7057ff&label=Contribute)](https://github.com/nextcloud/forms/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
affan98's avatar
affan98 committed
7

8
**📝 Simple surveys and questionnaires, self-hosted**
affan98's avatar
affan98 committed
9

10
### Straightforward form creation
Jonas Rittershofer's avatar
Jonas Rittershofer committed
11
![](screenshots/forms1.png)
affan98's avatar
affan98 committed
12

13
14
15
16
17
18
### Simple sharing and responding
![](screenshots/forms2.png)

### Response visualization and exporting
![](screenshots/forms3.png)

19
- **📝 Simple design:** No mass of options, only the essentials. Works well on mobile of course.
20
21
- **📊 View & export results:** Results are visualized and can also be exported as CSV in the same format used by Google Forms.
- **🔒 Data under your control!** Unlike in Google Forms, Typeform, Doodle and others, the survey info and responses are kept private on your instance.
22
- **🙋 Get involved!** We have lots of stuff planned like more question types, collaboration on forms, [and much more](https://github.com/nextcloud/forms/milestones)!
affan98's avatar
affan98 committed
23
24


25
## 🏗 Development setup
affan98's avatar
affan98 committed
26

27
28
29
30
1. ☁ Clone this app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/forms.git`
2. 👩‍💻 In the folder of the app, run the command `npm ci && npm run dev` to install dependencies and build the Javascript.
3. ✅ Enable the app through the app management of your Nextcloud
4. 🎉 Partytime! Help fix [some issues](https://github.com/nextcloud/forms/issues) and [review pull requests](https://github.com/nextcloud/forms/pulls) 👍
affan98's avatar
affan98 committed
31
32


33
### 🧙 Advanced development stuff
affan98's avatar
affan98 committed
34

35
To build the Javascript whenever you make changes, you can also use `npm run build`. Or `npm run watch` to automatically rebuild on every file save.
affan98's avatar
affan98 committed
36

37
You run all tests by using `make test`.
slink58's avatar
slink58 committed
38

affan98's avatar
affan98 committed
39

40
## ♥ How to create a pull request
affan98's avatar
affan98 committed
41

42
43
This guide will help you get started:
- 💃 [Opening a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request)
slink58's avatar
slink58 committed
44

affan98's avatar
affan98 committed
45

46
## ✌ Code of conduct
affan98's avatar
affan98 committed
47

48
The Nextcloud community has core values that are shared between all members during conferences, hackweeks and on all interactions in online platforms including [Github](https://github.com/nextcloud) and [forums](https://help.nextcloud.com). If you contribute, participate or interact with this community, please respect [our shared values](https://nextcloud.com/code-of-conduct/). 😌