deblan/forms
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update readme

Browse source 
Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
This commit is contained in:
John Molakvoæ (skjnldsv) 2019-09-09 10:06:56 +02:00
parent dc5a674dbc
commit 5a6d19ba47
No known key found for this signature in database
GPG key ID: 60C25B8C072916CF
1 changed files with 32 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
README.md
View file

@ -6,59 +6,44 @@ Forms allows the creation of shareable forms, with multiple question types and p
**Note**: This app is tested with Apache2 webserver, MySQL database, and apt-get package manager. To use alternatives, replace the relevant commands with those of your technology. This document assumes that a working **Note**: This app is tested with Apache2 webserver, MySQL database, and apt-get package manager. To use alternatives, replace the relevant commands with those of your technology. This document assumes that a working
NextCloud development environment has been installed. See https://docs.nextcloud.com/server/stable/developer_manual/general/devenv.html for help with this. NextCloud development environment has been installed. See https://docs.nextcloud.com/server/stable/developer_manual/general/devenv.html for help with this.
## Installation ## Build the app
### Download the Forms Codebase
```sh ``` bash
$ cd /var/www/html/nextcloud/apps # set up and build for production
$ git clone https://github.com/nextcloud/forms.git make
# install dependencies
make dev-setup
# build for dev and watch changes
make watch-js
# build for dev
make build-js
# build for production with minification
make build-js-production
```
## Running tests
You can use the provided Makefile to run all tests by using:
_ps: only works if you're using php locally and have forms installed info your apps default folder_
```
make test
``` ```
### Install Prerequisites and Dependencies ## :v: Code of conduct
#### Install NPM
```sh
$ apt-get npm
```
#### Install Yarn The Nextcloud community has core values that are shared between all members during conferences,
```sh hackweeks and on all interactions in online platforms including [Github](https://github.com/nextcloud) and [Forums](https://help.nextcloud.com).
$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - If you contribute, participate or interact with this community, please respect [our shared values](https://nextcloud.com/code-of-conduct/). :relieved:
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
$ apt update
$ apt install yarn
```
#### Update NodeJS
```sh
$ npm install -g n
$ n stable
```
### Build the App
```sh
$ cd /var/www/html/nextcloud/apps/forms
$ make all
```
### Start Webserver / Database ## :heart: How to create a pull request
```sh
$ service apache2 start
$ service mysql start
```
### Enable the App This guide will help you get started:
- Open NextCloud in your browser of choice - :dancer: :smile: [Opening a pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request)
- Click on the user icon in the top right of the screen, and select Apps from the drop down menu
- Find the Forms app in the list and click enable
- The app will now be fully functional! The forms icon will appear on the top toolbar of NextCloud after it has been enabled
### To Rebuild
```
$ cd /var/www/html/nextcloud/apps/forms
$ npm run build
$ service Apache2 restart
$ service mysql restart
```
Refresh the page in your browser to reflect the changes.
## Code Overview ## Code Overview
The following are the most important code files for development of the Forms App. The following are the most important code files for development of the Forms App.