@simply-fin-services/astronomix3

Astronomix 3.0

Usage no npm install needed!

<script type="module">
  import simplyFinServicesAstronomix3 from 'https://cdn.skypack.dev/@simply-fin-services/astronomix3';
</script>

README

To get started, in one tab, run: $ cd astronomix3 && npm i && npm run storybook

astronomix3

Astronomix 3.0

Node Version 14 or greater required

Install

npm install --save @simply-fin-services/astronomix3

Deploy

Because there is no pipeline yet you need to do your own deploys. 😱 To do this you need to bump the version and publish it to npm. Get access to the project and make sure you have done all the npm things you need to do in order to publish from the terminal.

# old school way:
npm version patch && npm publish

# npm run scripts way:
npm run go

Usage

import React from 'react'
import MyComponent from '@simply-fin-services/astronomix3'

const Foo = (props) => {
  return (
    <React.Fragment>
      <MyComponent />
    </React.Fragment>
  )
}

Testing locally on different apps

Instead of deploying a pre-release and hosting, the necessary files can be copied to the appropriate apps. Have a look at some existing scripts:

npm run cp:tenandsix, npm run cp:suffix and npm run cp:asterix

Add new apps

Follow the cp naming standard which stands for copy.

  • Build astro.
  • Identify where the files reside in the app.
  • Delete these files. (it's okay because they are in git)
  • Copy the necessary files across to the app. (eg just the dist directory)
  • Make sure the directories follow the expected naming convention.

Environment

Install nvm so that you can run multiple instances of node. curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh | bash

If you are experiencing problems with nvm and you installed it via homebrew, please see if one of these solutions will help you. 🤞

License

MIT © pierrenel