@soton.ac.uk/cape3
TypeScript icon, indicating that this package has built-in type declarations

0.28.0 • Public • Published

CAPE3

CAPE3 is a Vue plugin/application to enable websites that expose simple spreadsheet based data sets online.

Quickstart: Setting up a Cape3 Project

Create a new vue3 project using: npm create vue@latest With some options TBD. (Typescript, not router or pinia)

Edit src/main.ts to be:

import './assets/main.css'
import createCapeApp from '@/createCapeApp'
import { LoggingLevel } from './logging/loggingLevel'
import ConsoleLoggingPlugin from '@/plugins/ConsoleLoggingPlugin'

const app = createCapeApp({ siteData: 'site-data.json' })
app.use(ConsoleLoggingPlugin, { LoggingLevel: LoggingLevel.Error })
app.mount('#app')

And add a valid site-data.json file (probably created by the cape-mapper tool). See CreateCapeApp options for more options accepted by Cape3.

Remove all files and folders in src/ except for main.ts and assets

Edit the vite.config.ts and add the following option to the resolve.alias section: vue: 'vue/dist/vue.esm-bundler.js' // allow run time compilation of templates from index.html

TODO: Consider a better starting site.css for a Cape project.

Readme

Keywords

none

Package Sidebar

Install

npm i @soton.ac.uk/cape3

Weekly Downloads

3

Version

0.28.0

License

none

Unpacked Size

1.04 MB

Total Files

55

Last publish

Collaborators

  • martin_soton
  • dp11g14
  • rassoton