update readme
This commit is contained in:
parent
ae3b7a310b
commit
a620971276
37
README.md
37
README.md
@ -1,5 +1,11 @@
|
||||
# OhMyForm API
|
||||
|
||||
[](https://opencollective.com/ohmyform-sustainability)
|
||||

|
||||
|
||||
[](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
8
doc/development.md
Normal 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`
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "ohmyform-api",
|
||||
"version": "0.3.0",
|
||||
"version": "0.9.0",
|
||||
"description": "",
|
||||
"author": "",
|
||||
"license": "MIT",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user