Simplify and standardize the creation and open sourcing of frontend projects.
- 👩💻 Start From CLI: create a new project with one single command
- 📐 Project Layout: follow a clear and pre-defined project structure to make open sourcing easy
- 🔧 Integrated Tooling: conscious choice of tools, configured and accessible via npm/yarn scripts
- 🎡 Automated tasks: from commit message checking to changelog generation for releases
We know that the process of open sourcing projects can sometimes be confusing. And figuring out how to start and knowing what to include can be daunting.
That's why we decided to standardize the process of open sourcing at ResearchGate so that your experience with open sourcing is easy and enjoyable.
With this project, we aim to answer your open questions and facilitate this process by providing clear guidelines on how to structure and document your projects, and which tools you should use.
Install Node Package Blueprint as a global npm package:
npm install -g @researchgate/node-package-blueprint
Now create a new project with the CLI tool:
node-package-blueprint my-project
cd my-project/
🏁 Your project is ready! Take a look at the folder contents and when ready, install the dependencies:
yarn install
Once you're ready to release a new version use:
yarn release
This script will calculate the version number based on your commit history – always make sure you follow the conventional commits guidelines we've outlined. The CHANGELOG.md file is automatically updated with the relevant changes.
If it's your first release, it's probably not a good idea to bump a new version into the history. For these cases, use the --first-release flag:
yarn release -- --first-release
Our documentation is structured in sections directly available under the docs folder:
We'd love your help on creating Node Package Blueprint!
Before you do, please read our Code of Conduct so you know what we expect when you contribute to our projects.
Our Contributing Guide tells you about our development process and what we're looking for, gives you instructions on how to issue bugs and suggest features, and explains how you can build and test your changes.
Haven't contributed to an open source project before? No problem! Contributing Guide has you covered as well.