README.md 1.76 KB
Newer Older
Michael Henretty's avatar
Michael Henretty committed
1
## Common Voice ![Travis Status](https://travis-ci.org/mozilla/voice-web.svg?branch=master "Travis Status")
Tiago Morais Morgado's avatar
Tiago Morais Morgado committed
2
This is a web, android and iOS app for collecting speech
Michael Henretty's avatar
Michael Henretty committed
3
donations for the Common Voice project.
4

5
### Official Website
Michael Henretty's avatar
Michael Henretty committed
6
[voice.mozilla.org](https://voice.mozilla.org)
7

8
### Contribution
Michael Henretty's avatar
Michael Henretty committed
9
[Non-code] Please help us add sentences to read. See [issue 341](https://github.com/mozilla/voice-web/issues/341) for details.
10

11
[Code] Check out our list of [help wanted bugs](https://github.com/mozilla/voice-web/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
12

13 14 15
Did you notice a bug? Do you have a feature request? Please file an issue [here on GitHub](https://github.com/mozilla/voice-web/issues).

For general discussion (feedback, ideas, random musings), check out our [Discourse Category](https://discourse.mozilla-community.org/c/voice).
16

17 18 19 20 21 22 23
### Development
```
npm install
npm install -g gulp
gulp
```
This will:
Michael Henretty's avatar
Michael Henretty committed
24
1. Install all JavaScript dependencies.
25
1. Build and serve files located in the `web` folder on localhost.
Michael Henretty's avatar
Michael Henretty committed
26
1. Save uploaded voice clips onto Amazon's S3.
27
1. Lint and rebuild all js files on every change.
Michael Henretty's avatar
Michael Henretty committed
28

29 30 31 32 33 34 35
### Help

For more options type:
```
gulp help
```

36 37 38 39
### Project directory structure

The project is organized into the following directories:

Michael Henretty's avatar
Michael Henretty committed
40 41 42 43 44 45 46
- *android*: The Android app, simple webview wrapper of voice.mozilla.org. This app is not currently published.
- *docs*: Design and data specifications for Common Voice.
- *ios*: The iOS app. At the time of it's publishing, this was a workaround for Safari not supporting getUserMedia.
- *nubis*: Configuration files for [Nubis](https://github.com/nubisproject), our deployment tool.
- *server*: The server-side code app logic written in NodeJS.
- *tools*: Just some scripts for managing data.
- *web*: The Common Voice website files.