diff --git a/.babelrc b/.babelrc
index 9897749..30c1842 100644
--- a/.babelrc
+++ b/.babelrc
@@ -1,5 +1,8 @@
{
"presets": [
- ["es2015", { "modules": false }]
- ]
+ ["@babel/preset-env", {
+ "useBuiltIns": false
+ }]
+ ],
+ "plugins": ["@babel/plugin-transform-runtime"]
}
diff --git a/.gitignore b/.gitignore
index 6905a16..3a0ead1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,12 @@
-.DS_Store
+# config file - copy config.json.example
+src/config.json
+
+# Build directory
+dist/
+
+# Node packages
node_modules/
npm-debug.log
-dist/
+
+# MacOS trash
+.DS_Store
diff --git a/README.md b/README.md
index b36760c..80af768 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,19 @@ A Vue.js project.
[TMDB Vue App](https://tmdb-vue-app.herokuapp.com/)
+## Config setup
+Set seasonedShows api endpoint and/or elastic.
+ - SeasonedShows [can be found here](https://github.com/kevinmidboe/seasonedshows) and is the matching backend to fetch tmdb search results, tmdb lists, request new content, check plex status and lets owner search and add torrents to download.
+ - Elastic is optional and can be used for a instant search feature for all movies and shows registered in tmdb.
+
+```json
+{
+ "SEASONED_URL": "http://localhost:31459/api",
+ "ELASTIC_URL": "http://localhost:9200"
+}
+```
+*Set ELASTIC_URL to undefined or false to disable*
+
## Build Setup
``` bash
@@ -24,5 +37,9 @@ npm run build
For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).
This app uses [history mode](https://router.vuejs.org/en/essentials/history-mode.html)
+## Documentation
+All api functions are documented in `/docs` and [found here](docs/api.md).
+[html version also available](http://htmlpreview.github.io/?https://github.com/KevinMidboe/seasoned/blob/release/v2/docs/api/index.html)
+
## License
[MIT](https://github.com/dmtrbrl/tmdb-app/blob/master/LICENSE)
diff --git a/docs/api.md b/docs/api.md
new file mode 100644
index 0000000..6b0dda1
--- /dev/null
+++ b/docs/api.md
@@ -0,0 +1,154 @@
+
+
+### Table of Contents
+
+- [getMovie][1]
+ - [Parameters][2]
+- [getShow][3]
+ - [Parameters][4]
+- [getTmdbListByPath][5]
+ - [Parameters][6]
+- [searchTmdb][7]
+ - [Parameters][8]
+- [searchTorrents][9]
+ - [Parameters][10]
+- [addMagnet][11]
+ - [Parameters][12]
+- [request][13]
+ - [Parameters][14]
+- [elasticSearchMoviesAndShows][15]
+ - [Parameters][16]
+
+## getMovie
+
+Fetches tmdb movie by id. Can optionally include cast credits in result object.
+
+### Parameters
+
+- `id` **[number][17]**
+- `credits` **[boolean][18]** Include credits (optional, default `false`)
+
+Returns **[object][19]** Tmdb response
+
+## getShow
+
+Fetches tmdb show by id. Can optionally include cast credits in result object.
+
+### Parameters
+
+- `id` **[number][17]**
+- `credits` **[boolean][18]** Include credits (optional, default `false`)
+
+Returns **[object][19]** Tmdb response
+
+## getTmdbListByPath
+
+Fetches tmdb list by path.
+
+### Parameters
+
+- `listPath` **[string][20]** Path of list
+- `page` **[number][17]** (optional, default `1`)
+
+Returns **[object][19]** Tmdb list response
+
+## searchTmdb
+
+Fetches tmdb movies and shows by query.
+
+### Parameters
+
+- `query` **[string][20]**
+- `page` **[number][17]** (optional, default `1`)
+
+Returns **[object][19]** Tmdb response
+
+## searchTorrents
+
+Search for torrents by query
+
+### Parameters
+
+- `query` **[string][20]**
+- `authorization_token`
+- `credits` **[boolean][18]** Include credits
+
+Returns **[object][19]** Torrent response
+
+## addMagnet
+
+Add magnet to download queue.
+
+### Parameters
+
+- `magnet` **[string][20]** Magnet link
+- `name` **[boolean][18]** Name of torrent
+- `tmdb_id` **[boolean][18]**
+
+Returns **[object][19]** Success/Failure response
+
+## request
+
+Request a movie or show from id. If authorization token is included the user will be linked
+to the requested item.
+
+### Parameters
+
+- `id` **[number][17]** Movie or show id
+- `type` **[string][20]** Movie or show type
+- `authorization_token` **[string][20]?** To identify the requesting user (optional, default `undefined`)
+
+Returns **[object][19]** Success/Failure response
+
+## elasticSearchMoviesAndShows
+
+Search elastic indexes movies and shows by query. Doc includes Tmdb daily export of Movies and
+Tv Shows. See tmdb docs for more info: [https://developers.themoviedb.org/3/getting-started/daily-file-exports][21]
+
+### Parameters
+
+- `query` **[string][20]**
+
+Returns **[object][19]** List of movies and shows matching query
+
+[1]: #getmovie
+
+[2]: #parameters
+
+[3]: #getshow
+
+[4]: #parameters-1
+
+[5]: #gettmdblistbypath
+
+[6]: #parameters-2
+
+[7]: #searchtmdb
+
+[8]: #parameters-3
+
+[9]: #searchtorrents
+
+[10]: #parameters-4
+
+[11]: #addmagnet
+
+[12]: #parameters-5
+
+[13]: #request
+
+[14]: #parameters-6
+
+[15]: #elasticsearchmoviesandshows
+
+[16]: #parameters-7
+
+[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[21]: https://developers.themoviedb.org/3/getting-started/daily-file-exports
diff --git a/index.html b/index.html
index af6926d..c31f805 100644
--- a/index.html
+++ b/index.html
@@ -3,7 +3,7 @@
-
+
TMDb
@@ -14,6 +14,26 @@