update readme

This commit is contained in:
Michael Schramm 2020-06-01 00:53:28 +02:00
parent ae3b7a310b
commit a620971276
3 changed files with 18 additions and 29 deletions

View File

@ -1,5 +1,11 @@
# OhMyForm API
[![Financial Contributors on Open Collective](https://opencollective.com/ohmyform-sustainability/all/badge.svg?label=financial+contributors)](https://opencollective.com/ohmyform-sustainability)
![Project Status](https://img.shields.io/badge/status-0.9.0-green.svg)
[![Discord](https://img.shields.io/discord/595773457862492190.svg?label=Discord%20Chat)](https://discord.gg/MJqAuAZ)
> An *open source alternative to TypeForm* that can create stunning mobile-ready forms, surveys and questionnaires.
## Description
[OhMyForm](https://github.com/ohmyforn) api backend
@ -17,36 +23,11 @@ $ npm install
```bash
# development
$ npm run start
$ yarn run start
# watch mode
$ npm run start:dev
$ yarn run start:dev
# production mode
$ npm run start:prod
$ yarn run start:prod
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Support
TODO
## Stay in touch
- Website - [https://ohmyform.com](https://ohmyform.com/)
## License
TODO

8
doc/development.md Normal file
View File

@ -0,0 +1,8 @@
# Development
tip's and tricks to get you started
## First Run
install yarn on your system if not already present and then install all dependencies
by running `yarn install`

View File

@ -1,6 +1,6 @@
{
"name": "ohmyform-api",
"version": "0.3.0",
"version": "0.9.0",
"description": "",
"author": "",
"license": "MIT",