Skip to content

Commit f371db0

Browse files
committed
Updated DOCS and new release
1 parent c15d05a commit f371db0

File tree

6 files changed

+56
-16
lines changed

6 files changed

+56
-16
lines changed

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,11 @@ A small AI application containing [Angular 5](https://angular.io), [Material](ht
1717
* Dialogflow AI
1818
* Chatbot
1919

20-
## Example sentences
21-
* Can you get smarter?
22-
* You're boring
23-
* Who is your boss?
24-
* You are funny
25-
* Are we friends?
26-
* I'll be back
27-
* You're wrong
28-
* Nice to see you!
29-
* What's up?
30-
* I don't want to talk
31-
* Today is my birthday
32-
* I need an advice
20+
## Sentences
21+
[A couple of example sentences to get you start talking](https://github.com/jeroenouw/AngularAI/blob/master/docs/SENTENCES.md)
22+
23+
## Developing
24+
[Quick starting and development](https://github.com/jeroenouw/AngularAI/blob/master/docs/DEVELOPING.md)
3325

3426
## Contributing
3527
Want to file a bug, contribute some code, or improve documentation? Feel free to place an [issue](https://github.com/jeroenouw/AngularAI/issues).

docs/DEVELOPING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Quick start
2+
First clone this repo: `git clone https://github.com/jeroenouw/AngularAI.git`.
3+
Change directory to this project
4+
Run `npm install` to install all the dependencies.
5+
Run `npm start` to run this project. This will run with the AoT Compiler.
6+
Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
7+
8+
## Development
9+
For own projects please use different token `src/environment/environment.prod.ts` and `src/environment/environment.ts`:
10+
``` dialogflow: { ```
11+
``` [CHOOSE_A_NAME]': '[YOUR_TOKEN]' ```
12+
``` }```
13+
14+
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.
15+
16+
To build the development environment, run `npm run dist`.
17+
18+
## Production
19+
To build the default production environment, run `npm run prod`. This will run with the AoT Compiler.
20+
To build the production environment with reduced file size, run `npm run prod:opt` (Takes extra time to build with build optimizer).
21+
22+
## Speech Options
23+
Available speech recognition options in `src/app/service/ai.service.ts`
24+
25+
Choose if the API needs to look for further words:
26+
`this.speechRecognition.continuous = false;`
27+
28+
Show interim results or just final results:
29+
`this.speechRecognition.interimResults = false;`
30+
31+
Select your speech language:
32+
`this.speechRecognition.lang = 'en-us';`
33+
34+
Choose the quantity of alternative available matches:
35+
`this.speechRecognition.maxAlternatives = 0;`

docs/SENTENCES.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Example sentences
2+
* Can you get smarter?
3+
* You're boring
4+
* Who is your boss?
5+
* You are funny
6+
* Are we friends?
7+
* I'll be back
8+
* You're wrong
9+
* Nice to see you!
10+
* What's up?
11+
* I don't want to talk
12+
* Today is my birthday
13+
* I need an advice

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
{
22
"name": "ngx-ai",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"author": "Jeroen Ouwehand",
55
"description": "Angular 5 AI",
66
"keywords": [
77
"angular",
88
"dialogflow",
9+
"web speech api",
910
"google",
1011
"material",
1112
"chatbot",

src/index.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="icon" type="image/x-icon" href="favicon.ico">
1010

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

0 commit comments

Comments
 (0)