Scaffolding tools for creating and mainting projects based on WebReady Projects Open Source standards and best practices.
The project has 3 parts -
A cookiecutter template to generate necessary files for a WebReady Projects.
Install cookiecutter
command line: pip install cookiecutter
Run cookiecutter against this repository.
cookiecutter htps://github.com/wr-projects/monorepojs-scaffolding
or cookiecutter gh:wr-projects/monorepojs-scaffolding
or
You can also run it locally after cloning this repository:
cookiecutter /path/to/directory
See [documentation]() for more usage instructions.
See cookiecutter.json for all the variables required as input. Here is the list of places they are used
organization
:discord_url
:organiation_email
:support_email
:project_owner
:owner_email
:project_slug
:github_repo_url
: short_description
:project_homepage
:documentation_homepage
:package_slug
:package_description
:package_license_type
:release_year
:If you need to add headers to a lot of files, we recommend using the google/addlicense tool.
Lint all the necessary files in the project. - Project Homepage
npx repolinter /my/code/dir
npx repolinter --git https://my.git.code/awesome
npm install npx
first.Gregoire Favreau 📆 |
Thanks to Cookiecutter for the utility
Follow @WebReadyProjects on Twitter for updates.