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