|
1 | 1 | ## OpenDock |
2 | 2 | OpenDock is an open source frontend for the [SpaceDock-Backend](https://github.com/KSP-SpaceDock/SpaceDock-Backend) software, an API backend for hosting game modifications. |
3 | | -This is an unofficial project by SpaceDock-Backend developers to create a testbed where the communication between backend and frontend can be researched, until the real frontend for SpaceDock gets finished. |
4 | | -**It is not and will not be the official UI.** Use this at your own risk - you will probably need to do a lot of changes to adapt it to your needs and we wont support it like we support the official SpaceDock applications. |
| 3 | +This a project to develop a frontend that is capable of using the data provided by the SpaceDock-Backend API, to display a fully useable mod site. When it is finished, it has the potential to become the official frontend |
| 4 | +used by [spacedock.info](https://spacedock.info). |
| 5 | + |
| 6 | +### SDB Plugins |
| 7 | +OpenDock requires the installation of plugins in the SDB instance it uses. These plugins are located in [SpaceDock-Extras](https://github.com/KSP-SpaceDock/SpaceDock-Extras), namely |
| 8 | + |
| 9 | +* adapter |
| 10 | +* ckan |
| 11 | +* media |
| 12 | +* search |
| 13 | +* transformers |
| 14 | + |
| 15 | +The `plugins.txt` file that gets used should look like this |
| 16 | + |
| 17 | +``` |
| 18 | +github.com/KSP-SpaceDock/SpaceDock-Extras/plugins/adapter |
| 19 | +github.com/KSP-SpaceDock/SpaceDock-Extras/plugins/ckan |
| 20 | +github.com/KSP-SpaceDock/SpaceDock-Extras/plugins/media |
| 21 | +github.com/KSP-SpaceDock/SpaceDock-Extras/plugins/search |
| 22 | +github.com/KSP-SpaceDock/SpaceDock-Extras/plugins/transformers |
| 23 | +``` |
5 | 24 |
|
6 | 25 | ### Authors |
7 | 26 | The list of authors can be found in the [THANKS file](THANKS). |
8 | 27 |
|
9 | 28 | ### License |
10 | 29 | This application is licensed under the MIT License. You are free to remix, adapt and redistribute it, however, please credit the original authors |
11 | | -This uses the following jQuery Plugins: |
| 30 | + |
| 31 | +OpenDock uses the slim, jQuery and vue.js frameworks to do its work. |
| 32 | + |
| 33 | +It uses the following jQuery Plugins: |
12 | 34 | * http://www.jqueryscript.net/loading/Small-Loading-Modal-Overlay-Plugin-With-jQuery-loadingBlock.html |
13 | 35 | * http://stefangabos.ro/jquery/zebra-dialog/ |
14 | 36 |
|
|
1 commit comments
HebaruSan commentedon Feb 16, 2018
👍