Skip to content

Commit

Permalink
Updated DOCS and new release
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroenouw committed Nov 5, 2017
1 parent c15d05a commit f371db0
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 16 deletions.
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,11 @@ A small AI application containing [Angular 5](https://angular.io), [Material](ht
* Dialogflow AI
* Chatbot

## Example sentences
* Can you get smarter?
* You're boring
* Who is your boss?
* You are funny
* Are we friends?
* I'll be back
* You're wrong
* Nice to see you!
* What's up?
* I don't want to talk
* Today is my birthday
* I need an advice
## Sentences
[A couple of example sentences to get you start talking](https://github.com/jeroenouw/AngularAI/blob/master/docs/SENTENCES.md)

## Developing
[Quick starting and development](https://github.com/jeroenouw/AngularAI/blob/master/docs/DEVELOPING.md)

## Contributing
Want to file a bug, contribute some code, or improve documentation? Feel free to place an [issue](https://github.com/jeroenouw/AngularAI/issues).
Expand Down
35 changes: 35 additions & 0 deletions docs/DEVELOPING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## Quick start
First clone this repo: `git clone https://github.com/jeroenouw/AngularAI.git`.
Change directory to this project
Run `npm install` to install all the dependencies.
Run `npm start` to run this project. This will run with the AoT Compiler.
Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

## Development
For own projects please use different token `src/environment/environment.prod.ts` and `src/environment/environment.ts`:
``` dialogflow: { ```
``` [CHOOSE_A_NAME]': '[YOUR_TOKEN]' ```
``` }```

Run `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

To build the development environment, run `npm run dist`.

## Production
To build the default production environment, run `npm run prod`. This will run with the AoT Compiler.
To build the production environment with reduced file size, run `npm run prod:opt` (Takes extra time to build with build optimizer).

## Speech Options
Available speech recognition options in `src/app/service/ai.service.ts`

Choose if the API needs to look for further words:
`this.speechRecognition.continuous = false;`

Show interim results or just final results:
`this.speechRecognition.interimResults = false;`

Select your speech language:
`this.speechRecognition.lang = 'en-us';`

Choose the quantity of alternative available matches:
`this.speechRecognition.maxAlternatives = 0;`
13 changes: 13 additions & 0 deletions docs/SENTENCES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Example sentences
* Can you get smarter?
* You're boring
* Who is your boss?
* You are funny
* Are we friends?
* I'll be back
* You're wrong
* Nice to see you!
* What's up?
* I don't want to talk
* Today is my birthday
* I need an advice
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"name": "ngx-ai",
"version": "1.0.1",
"version": "1.0.2",
"author": "Jeroen Ouwehand",
"description": "Angular 5 AI",
"keywords": [
"angular",
"dialogflow",
"web speech api",
"google",
"material",
"chatbot",
Expand Down
1 change: 0 additions & 1 deletion src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="favicon.ico">

<link href="styles.scss" rel="stylesheet">
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500" rel="stylesheet">
</head>
Expand Down

0 comments on commit f371db0

Please sign in to comment.