UNPKG

@simply-fin-services/astronomix

Version:

astronomix components

74 lines (41 loc) • 2.28 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# astronomix [![npm package][npm-badge]][npm] # Using ### Via Npm * Install React version 16.x * `npm install @simply-fin-services/astronomix --save** * astronomix assumes you have a bundler like webpack setup. You will require * sass-loader: example <https://github.com/insin/nwb-sass/blob/master/index.js> * less-loader: example <https://github.com/insin/nwb-less/blob/master/index.js> * note you need to set 'javascriptEnabled' as true for less version 3 ### Via UDM * Install React version 16.x * Include the relevant js and css files from <https://unpkg.com/floops@0.0.7/umd/>. Remember to spesify the correct version # Development This library is based if <https://github.com/insin/nwb> react-component. See documentation for details. `npm run start` will start the development server and load the Demo application that is found in the demo folder. Use the demo app to test components as well as to explain their usage. The Demo app will be deployed to gitlab pages. Latest version: <https://simplyfinservices.gitlab.io/astronomix> ### Components Components are defined with their styles in their own folders inside of src. Once a component is completed be sure to export it from src/index.js. - MyButton - index.js - style.scss ### Styles Component specific styles should be added in the components folder. More generic style changes can be added in the src/styles folder. Remember that variables are good and should be specified and included from the variables.less. The Ant.Design theme can be changed in the ant.less file. ### Todo List _DEV_ * when happy with the process only deploy tags to gitlab pages _OPTIMIZATIONS_ * update readme for consuming styles * shrink and minifiy css and all the related things _DEPLOY_ * consume with antizer like cljs * build base containers for super fast deploys # Deploying Once you are ready to deploy a new version you should do the following 1. npm version patch|minor|major (this will bump the version and tag the build) 2. npm run deploy (this will push the new version tag to gitlab resulting in a new npm build and a deployment to github pages) [npm-badge]: https://img.shields.io/npm/v/npm-package.png?style=flat-square [npm]: https://www.npmjs.org/package/simply-astronomix