An open API service indexing awesome lists of open source software.

https://github.com/veritone/veritone-app-boilerplate-react

Fully-featured boilerplate for starting Veritone powered web application (SPA) projects
https://github.com/veritone/veritone-app-boilerplate-react

react redux sample veritone

Last synced: 4 months ago
JSON representation

Fully-featured boilerplate for starting Veritone powered web application (SPA) projects

Awesome Lists containing this project

README

          

# Veritone App Boilerplate - React

The [Veritone][veri] app boilerplate is a full-fledged boilerplate for creating [Veritone][veri] powered web applications ([SPA](https://en.wikipedia.org/wiki/Single-page_application)s).

### Tech Stack

- [React][react] + [Redux][redux] for UI and state management.

### Requirements

- node `^8.11.0`
- yarn `^1.6.0`

You can use [nvm](https://github.com/creationix/nvm#installation) to easily switch Node versions between different projects.

### Installation

We use [Yarn](https://yarnpkg.com/) for dependency management.

```bash
$ yarn install # Install project dependencies
```

### Quick Start

- Clone this repo and install the dependencies

```sh
git clone https://github.com/veritone/veritone-app-boilerplate-react.git
cd veritone-app-boilerplate-react/
yarn install
```

- [Create a Veritone developer account](https://www.veritone.com/onboarding/#/signUp?type=developer) if you don't already have one.

- [Register a new Veritone application](https://developer.veritone.com/applications/overview/new/details).

- URL: `http://localhost:3001`
- Oauth2 Redirect URL: `http://localhost:3001`

- Add your application's Client ID, found in Developer App, to `config.json` at the key `OAuthClientID`.

- Start the development server

```sh
yarn start
```

- The sample app should now be serving at `http://localhost:3001`.

### Building for Production

```bash
$ yarn build # Build production assets
```

[react]: https://facebook.github.io/react/
[redux]: http://redux.js.org/
[veri]: https://veritone.com/
[rdce]: https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd

### Creating a new project based on this boilerplate

1. Create and enter a directory for your project: `mkdir my-project; cd my-project`
2. Create a new git repo: `git init`
3. Add this boilerplate as a remote: `git remote add boilerplate https://github.com/veritone/veritone-app-boilerplate-react`
4. Fetch the new remote: `git fetch --all`
5. Merge the boilerplate: `git merge boilerplate/master`

### Merging boilerplate changes into an existing app

If you followed the steps above to create your project based on this boilerplate, staying up to date is simple:

1. Fetch the latest changes: `git fetch --all`
2. Merge the boilerplate: `git merge boilerplate/master`

# License

Copyright 2018, Veritone Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.