@soton.ac.uk/cape3 0.0.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -31
- package/dist/cape3.es.js +7903 -0
- package/dist/cape3.umd.js +45 -0
- package/dist/favicon.ico +0 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/plugins/CapePlugin.d.ts +7 -0
- package/dist/plugins/CapePlugin.d.ts.map +1 -0
- package/dist/site-data.json +266 -0
- package/dist/site.css +36 -0
- package/dist/style.css +1 -0
- package/dist/styles/cape-homepage-layout.css +30 -0
- package/dist/styles/cape-navigation-tabs.css +34 -0
- package/dist/styles/defaults.css +5 -0
- package/package.json +82 -80
package/README.md
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
# CAPE3
|
|
2
|
-
|
|
3
|
-
CAPE3 is a Vue plugin/application to enable websites that expose simple spreadsheet based data sets online.
|
|
4
|
-
|
|
5
|
-
- [createCapeApp options](./docs/CreateCapeAppOptions.md)
|
|
6
|
-
- [CAPE development guide](./docs/CapeDevelopment.md)
|
|
7
|
-
|
|
8
|
-
## Quickstart: Setting up a Cape3 Project
|
|
9
|
-
|
|
10
|
-
Create a new vue3 project using:
|
|
11
|
-
`npm create vue@latest`
|
|
12
|
-
With some options TBD. (Typescript, not router or pinia)
|
|
13
|
-
|
|
14
|
-
Edit src/main.ts to be:
|
|
15
|
-
|
|
16
|
-
```
|
|
17
|
-
import './assets/main.css'
|
|
18
|
-
import createCapeApp from '@/createCapeApp'
|
|
19
|
-
const app = createCapeApp({ siteData: 'site-data.json' })
|
|
20
|
-
app.mount('#app')
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
And add a valid site-data.json file (probably created by the cape-mapper tool). See [CreateCapeApp options](./docs/CreateCapeAppOptions.md) for more options accepted by Cape3.
|
|
24
|
-
|
|
25
|
-
Remove all files and folders in src/ except for main.ts and assets
|
|
26
|
-
|
|
27
|
-
Edit the vite.config.ts and add the following option to the resolve.alias section:
|
|
28
|
-
```vue: 'vue/dist/vue.esm-bundler.js' // allow run time compilation of templates from index.html```
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
TODO: Consider a better starting site.css for a Cape project.
|
|
1
|
+
# CAPE3
|
|
2
|
+
|
|
3
|
+
CAPE3 is a Vue plugin/application to enable websites that expose simple spreadsheet based data sets online.
|
|
4
|
+
|
|
5
|
+
- [createCapeApp options](./docs/CreateCapeAppOptions.md)
|
|
6
|
+
- [CAPE development guide](./docs/CapeDevelopment.md)
|
|
7
|
+
|
|
8
|
+
## Quickstart: Setting up a Cape3 Project
|
|
9
|
+
|
|
10
|
+
Create a new vue3 project using:
|
|
11
|
+
`npm create vue@latest`
|
|
12
|
+
With some options TBD. (Typescript, not router or pinia)
|
|
13
|
+
|
|
14
|
+
Edit src/main.ts to be:
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
import './assets/main.css'
|
|
18
|
+
import createCapeApp from '@/createCapeApp'
|
|
19
|
+
const app = createCapeApp({ siteData: 'site-data.json' })
|
|
20
|
+
app.mount('#app')
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
And add a valid site-data.json file (probably created by the cape-mapper tool). See [CreateCapeApp options](./docs/CreateCapeAppOptions.md) for more options accepted by Cape3.
|
|
24
|
+
|
|
25
|
+
Remove all files and folders in src/ except for main.ts and assets
|
|
26
|
+
|
|
27
|
+
Edit the vite.config.ts and add the following option to the resolve.alias section:
|
|
28
|
+
```vue: 'vue/dist/vue.esm-bundler.js' // allow run time compilation of templates from index.html```
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
TODO: Consider a better starting site.css for a Cape project.
|