⚡️ solid-nm ⚡️

This is exactly what I use for my own modules.

Instant node module starter-kit.

The problem

Don't let yourself for always having to setup any node module or open-source projects from scratch.

You should spend your time more on writing codes than setting them up.

This solution

This repo includes built-in modern tools which are widely-used in the community.

• Automated GitHub release notes generator
• Automated releasing with semantic-release
• Automated testing & validation before any commits
• Automated source-code formatting with prettier
• Babel transpiler
• Eslint
• Flow
• Jest
• React
• Travis CI
• Really? You need me to list them all here? 🐰

So you can shift your focus working on the project itself.

Setup

1. Get the source code

Clone this repo

$ git clone [email protected]:luftywiranda13/solid-nm.git my-module

Remove existing history from this repo

$ rm -rf .git
$ git init

2. Install dependencies

$ npm install

You don't have to use npm, use yarn if you want to.

3. Tweak as you need

You may need to change specific things like project name, badges, etc.

4. Validate the project

$ npm start validate

If it's all good, then you're ready to go!

How automated releasing works

It's 2017, you don't need to tag, bump version, write changelog, and publish to npm manually by yourself.

This is how to automate those processes:

1. Commit changes like you normally do

Add the changes you made

$ git add .

But instead of running git commit -m "blahblah", you need to run

npm start commit

Choose type of commit, then follow the instructions.

This way, you can make sure anyone who contribute to your repository write useful & meaningful commit message in to it. Then your changelog will be useful to the others too.

2. Push to GitHub

$ git push -u origin master

Manually do initial publishing to npm. remember you only need to do this only once

npm publish

Notice: don't bump your project's version manually. Ever!

3. Sit back and relax

Now let Travis CI and semantic-release do the releasing stuffs for you ☕ 💅

Tips

To find some more additional scripts you can run inside the project, run npm start on your terminal.

Those scripts are provided by nps.

Inspiration

Heavily inspired from Sindre Sorhus & Kent C. Dodds.

Other Solutions

I'm not aware of any. If you are, please make a pull request and add it here!

Contributors

Thanks goes to these people:

| Lufty Wiranda💻 📖 🔌 | | :---: |

This project follows the all-contributors specification. Contributions of any kind are welcome!

License

MIT © Lufty Wiranda.