Skip to content

ClearC2/package-template

Repository files navigation

c2-[package]

Creating a New Package From the Template

  1. Create a new GitHub repository without a readme
  2. Open Terminal
  3. Create a bare clone of this repository
$ git clone --bare git@github.com:ClearC2/package-template.git
  1. Mirror push to your new repository
$ cd package-template.git
$ git push --mirror <your new package git URI created in step 1>
  1. Remove the temporary local repository you created in step 3
$ cd ..
$ rm -rf package-template.git
  1. Change your package.json to conform to your new package instead of package-template. This includes:

    • name
    • description
    • keywords
    • repository URL
    • bugs URL
    • homepage URL
  2. Change the README.md to to conform to your package. This includes:

    • title
    • deleting the Creating a New Package From the Template section
  3. Change the alias section in the example/webpack.config.js file to resolve your new package name (i.e. change package-template to your package name)

  4. Change the import statement in example/src/App.js to use this new alias instead of package-template

  5. Commit your changes to the package.json, README.md, example/webpack.config.js, and example/src/App.js, and push them up to GitHub. Your package is now ready for development

TODO

  • Add Mocha/Chai/Enzyme/Istanbul test framework