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: 2 days 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 (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T22:31:13.000Z (13 days ago)
• Last Synced: 2024-10-25T08:47:45.792Z (13 days 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: 732 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Maintainer](https://img.shields.io/badge/Maintainer-WRProjects-7F187F)](https://github.com/wr-projects/)

![./LICENSE](https://img.shields.io/github/license/wr-projects/monorepojs-scaffolding)

[![REUSE status](https://api.reuse.software/badge/github.com/wr-projects/github-template)](https://api.reuse.software/info/github.com/wr-projects/monorepojs-scaffolding)

[![OSSLifecycle](https://img.shields.io/osslifecycle/wr-projects/github-template)](https://github.com/wr-projects/monorepojs-scaffolding/blob/main/OSSMETADATA)

[![Fosstars security rating](https://raw.githubusercontent.com/wr-projects/monorepojs-scaffolding/.github/assets/fosstars-report/fosstars-security-rating.svg)](https://github.com/wr-projects/monorepojs-scaffolding/blob/fosstars-report/fosstars_security_rating.md)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#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

  

    

      
Gregoire Favreau
📆

    

  

## 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)