https://github.com/wr-projects/monorepojs-scaffolding
💫 Tools to create JavaScript/TypeScript monorepos based on open source standards and best practices to create NodeJS packages.
https://github.com/wr-projects/monorepojs-scaffolding
2022 2022-project automated ci github github-actions github-automated github-jstemplate github-template javascript js open-source organization template ts typescript webreadyprojects workflows wrprojects
Last synced: about 2 months ago
JSON representation
💫 Tools to create JavaScript/TypeScript monorepos based on open source standards and best practices to create NodeJS packages.
- Host: GitHub
- URL: https://github.com/wr-projects/monorepojs-scaffolding
- Owner: wr-projects
- License: mit
- Created: 2022-12-23T23:32:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T23:41:36.000Z (about 1 year ago)
- Last Synced: 2025-03-20T03:03:39.452Z (about 1 year ago)
- Topics: 2022, 2022-project, automated, ci, github, github-actions, github-automated, github-jstemplate, github-template, javascript, js, open-source, organization, template, ts, typescript, webreadyprojects, workflows, wrprojects
- Language: Shell
- Homepage:
- Size: 643 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/wr-projects/)
[](https://api.reuse.software/info/github.com/wr-projects/monorepojs-scaffolding)
[](https://github.com/wr-projects/monorepojs-scaffolding/blob/main/OSSMETADATA)
[](https://github.com/wr-projects/monorepojs-scaffolding/blob/fosstars-report/fosstars_security_rating.md)
[](#contributors-)
# monorepojs-scaffolding
Scaffolding tools for creating and mainting projects based on WebReady Projects Open Source standards and best practices.
The project has 3 parts -
1. [Cookiecutter template to generate WRProjects OSS Policy files e.g. LICENSE, CONTRIBUTING, README, etc.]()
2. [Script to add License headers to all source files in a project]()
3. [Lint a repository for common missing files (repolinter)]()
---
## 1. Cookiecutter template to generate OSS policy files
A [cookiecutter](https://github.com/cookiecutter/cookiecutter) template to generate necessary files for a WebReady Projects.
### Requirements
Install `cookiecutter` command line: `pip install cookiecutter`
### Usage
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.
### Inputs
See [cookiecutter.json](/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`:
---
## 2. License Headers
If you need to add headers to a lot of files, we recommend using the [google/addlicense](https://github.com/wr-projects/addlicense) tool.
---
## 3. Linting (repolinter)
Lint all the necessary files in the project. - [Project Homepage](https://github.com/todogroup/repolinter)
- To run against a directory, use `npx repolinter /my/code/dir`
- To run against a git repository, use the --git option: `npx repolinter --git https://my.git.code/awesome`
- Note, if you are running a version of npm < 5.2.0, run `npm install npx` first.
---
## Contributors
## Credits
Thanks to [Cookiecutter](https://github.com/cookiecutter/cookiecutter) for the utility
## Social networks
Follow [@WebReadyProjects](https://twitter.com/WebReadyCompany) on Twitter for updates.
## License
[MIT](https://github.com/wr-projects/monorepojs-scaffolding/blob/main/LICENSE)
