Create npm module for easy installation by others.

[guylepage3]

Description
Create npm module for easy installation by others.

Tasks

• Devise structure of module
• Create npm (Node.js) module
  • Set up package.json file.
  • Rename Custom.scss to meta.scss
  • Move meta.scss into new scss/ directory in root.
  • Update import path of meta.scss through out the app.
    • Unable to import outside of src #20 Export scss to scss directory in root. React prevents import outside of the src folder. We could eject the app but then implementing cretae-react-app updates would be very complex.
  • Set up .npmignore file. npmjs.com > Keeping files out of your package
    • OR -
  • Create new script under scripts in package.json that;
    • Create a scss/ directory in root
    • Replace meta.scss from ./src/styles/ and place in ./scss/ directory
  • Set files to be included into the published npm package.
  • Create an create an npm Org.
    • @unimeta which is an acronym for "Universe Meta".
  • Publish scoped package
  • Test install by installing it into new create-react-app.

Next

• #21 Add css and minified css to npm package

[guylepage3]

NOTE: Updated the structure to be more simplified for first iteration of npm. See next iteration here

Structure of module

For this first iteration we will be restrictive in that it will require that the project/app Meta is being utilized on, uses, React.js, Sass and Bootstrap. We will modify this to be much more open in further versions.

Goal is to publish only a meta-framework/ directory with the following;

meta
├── LICENSE
├── package.json
├── README.md
└── scss/
   └── meta.scss

*NOTE: meta.scss will be broken up into many files such as colors.scss, buttons.scss, typography.scss, etc. as the framework grows.

Flow for v1

• Developer reads through install instructions.
• Executes typical "Bootstrap" installation process.
• Installs Meta.
  • Meta v1 is basically just a Sass file that overrides Bootstrap.
• Developer simply applies traditional classes from Bootstrap model to their project.

[guylepage3]

Done