2020-02-28 13:34:05 +03:00
# Nextcloud Forms
2020-05-27 00:02:02 +03:00
2020-02-28 13:34:05 +03:00
[](https://codecov.io/gh/nextcloud/forms/)
[](https://dependabot.com)
2020-05-27 00:02:02 +03:00
[](https://github.com/nextcloud/forms/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
2019-05-14 02:15:45 +03:00
2020-05-27 00:02:02 +03:00
**📝 Simple surveys and questionnaires, self-hosted**
2019-05-14 02:15:45 +03:00
2020-07-21 17:47:20 +03:00
### Straightforward form creation
2020-05-28 12:29:49 +03:00
2019-05-14 02:15:45 +03:00
2020-07-21 17:47:20 +03:00
### Simple sharing and responding
### Response visualization and exporting
2020-05-27 00:02:02 +03:00
- **📝 Simple design:** No mass of options, only the essentials. Works well on mobile of course.
2020-07-21 17:47:20 +03:00
- **📊 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.
2020-05-27 00:02:02 +03:00
- **🙋 Get involved!** We have lots of stuff planned like more question types, collaboration on forms, [and much more ](https://github.com/nextcloud/forms/milestones )!
2019-05-14 02:15:45 +03:00
2020-05-27 00:02:02 +03:00
## 🏗 Development setup
2019-05-14 02:15:45 +03:00
2020-05-27 00:02:02 +03:00
1. ☁ Clone this app into the `apps` folder of your Nextcloud: `git clone https://github.com/nextcloud/forms.git`
2022-04-24 21:28:18 +03:00
2. 👩💻 In the folder of the app, run the command `composer i && composer i && npm ci && npm run build` to install dependencies and build the Javascript.
2020-05-27 00:02:02 +03:00
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 ) 👍
2019-05-14 02:15:45 +03:00
2020-05-27 00:02:02 +03:00
### 🧙 Advanced development stuff
2019-05-14 02:15:45 +03:00
2022-04-24 21:28:18 +03:00
To build the Javascript whenever you make changes, you can use `npm run build` . Or `npm run watch` to automatically rebuild on every file save.
2019-05-14 02:15:45 +03:00
2022-04-24 21:28:18 +03:00
You run several tests by:
- `npm run lint` for JavaScript linting
- `npm run stylelint` for CSS linting
- `composer cs:check` for the Nextcloud php coding standard
- `composer lint` for php linting
- `composer test:unit` and `composer test:integration` to run the php functionality tests
2023-03-21 18:50:28 +03:00
- `composer psalm` for static code analysis
2019-05-14 10:52:50 +03:00
2019-05-14 02:15:45 +03:00
2020-05-27 00:02:02 +03:00
## ♥ How to create a pull request
2019-05-14 02:15:45 +03:00
2020-05-27 00:02:02 +03:00
This guide will help you get started:
- 💃 [Opening a pull request ](https://opensource.guide/how-to-contribute/#opening-a-pull-request )
2019-05-14 10:52:50 +03:00
2019-05-14 02:15:45 +03:00
2020-05-27 00:02:02 +03:00
## ✌ Code of conduct
2019-05-14 02:15:45 +03:00
2020-05-27 00:02:02 +03:00
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/ ). 😌
