Cutting-edge boilerplate for building Typescript NPM modules. Built on best modern practices.
MIT License
.svg
files as React components using rollup.git commit
standardsnpm test
or npm test -- --watch
or npm test -- --watchAll
watch
flag only reruns tests that are affected by file changeswatchAll
flag will rerun all tests when something changesnpm run build
index.es.js
) - Set as the value for module
in the package.json
file. Allows bundlers that support ES modules (like webpack and rollup) to use this module and get benefits like tree shaking.index.js
) - Set as the value for main
in the package.json
file. This is the standard format for NPM modules.index.css
that can be imported by adopters using an import like import 'your-npm-module/dist/index.css';
demo.js
bundle in /docs
so that you can see a demo of your NPM package served at docs/index.html
npm start
src/demo.tsx
file to build a "demo" implementation of your module. You can customize src/demo.tsx
as needed.npm run cm
npm run lint
Clone the repository into your "new-project" directory
git clone https://github.com/ctaylo21/TypescriptReactBoilerplate.git new-project && cd new-project
Remove the git repository, and then initialize a new one
rm -rf .git && git init
Remove README and replace with your own
rm README.md && touch README.md
Update package.json
and install dependencies
npm init && npm install
Don't forget to update the description and any URL's in the package.json
file.
Start coding!
Once you have created and pushed your new repo to GitHub:
Sign in to (or create) your Travis CI account and follow the instructions to enable Travis CI on your repo. This repo already includes a .travis.yml
, so you only need to active your repo.
Add your repo to your coveralls account. Then, grab the token from coveralls and put it in a new file called .coveralls.yml
file at the project root. It should contain:
repo_token: <your_repo_token>
By running npm run build
, a demo of your app will be created in the /docs
folder based upon the src/demo.tsx
file. Then, you can go to your GitHub repo > settings > GitHub Pages and update the Source
to point to master branch / docs folder
. Then, you have a functioning demo of your page at https://<your-github>.github.io/<your-repo-name>/
(Optional): Add a badge that shows the status of your NPM dev dependencies from david-dm.org.
If you find any problems or bugs, please open a new issue.