# create-foss-files

> Get all the files you need for an open-source project

Latest version **1.1.1** (published 2021-07-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-foss-files
pnpm add create-foss-files
yarn add create-foss-files
bun add create-foss-files
```

Provides the commands `cff`, `create-foss-files`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2021-07-10 |
| First published | 2021-07-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Saad Irfan |
| Maintainers | msaaddev |
| Keywords | open source, foss, open source files, license, code of conduct, editor configs, open source project, javascript, free and open source software, Saad Irfan, msaaddev |

## Links

- npm: https://www.npmjs.com/package/create-foss-files
- Repository: https://github.com/msaaddev/create-foss-files
- Homepage: https://github.com/msaaddev/create-foss-files#readme
- Issues: https://github.com/msaaddev/create-foss-files/issues
- npm.io page: https://npm.io/package/create-foss-files

## Dependencies (7)

- [ora](https://npm.io/package/ora.md) ^5.4.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [execa](https://npm.io/package/execa.md) ^5.1.1
- [exit-cli](https://npm.io/package/exit-cli.md) ^1.0.3
- [cli-welcome](https://npm.io/package/cli-welcome.md) ^2.2.2
- [log-symbols](https://npm.io/package/log-symbols.md) ^4.1.0
- [node-cli-handle-error](https://npm.io/package/node-cli-handle-error.md) ^1.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2021-07-10
- 1.1.0 — 2021-07-10
- 1.0.3 — 2021-07-10
- 1.0.2 — 2021-07-09
- 1.0.1 — 2021-07-09
- 1.0.0 — 2021-07-09

## README

![cover](assets/cover.jpg)

<div align="center">
	<img src="https://img.shields.io/npm/v/create-foss-files?color=fad000" alt="version">
	<img src="https://img.shields.io/npm/l/create-foss-files?color=fad000" alt="license">
	<img src="https://img.shields.io/npm/dt/create-foss-files?color=fad000" alt="downloads">
</div>
<br>

<p align="center">
Confused about which files you should have in your open-source project!? Well, I built this tool to help you just with this confusion. With a single command, you get all the files which you should have in you project.
</p>

![split](assets/separate.jpg)

- **Simple**: Extremely simple to use.
- **Cross-platform**: Works on macOS, linux, and Windows.
- **JavaScript files**: Generates additional files if you are developing a JavaScript project.
- **Prettier**: Integrated prettier if the project is a JavaScript project.
- **MIT Licensed**: Free to use for personal and commercial use.

## 📦 Installation

```sh
# install the CLI globally
npm install -g create-foss-files

# use it with npx (recommended)
npx create-foss-files --flag
```

## 🚀 Usage

Create a new project folder. Navigate into it. Run any of the following command inside of it.

```sh
# if installed globally (only generates required files)
cff

# if installed globally (add JavaScript files)
cff --javascript

# with npx (only generates required files)
npx create-foss-files

# with npx (add JavaScript files)
npx create-foss-files --javascript
```

## 🏗 Directory Structure

Directory tree with `cff`

```
└── [project name]
    ├── .editorconfig
    ├── .gitattributes
    ├── .gitignore
    ├── changelog.md
    ├── code-of-conduct.md
    ├── contributing.md
    ├── license
    └── readme
```

Directory tree with `cff --javascript`

```
└── [project name]
    ├── .editorconfig
    ├── .gitattributes
    ├── .gitignore
    ├── .npmrc
    ├── .prettierrc.json
    ├── changelog.md
    ├── code-of-conduct.md
    ├── contributing.md
    ├── index.js
    ├── license
    ├── package.json
    └── readme
```


## 👨🏻‍💻 Contributing

Make sure you read the [contributing guidelines](https://github.com/msaaddev/create-foss-files/blob/master/contributing.md) before opening a PR.

## 🔑 License & Conduct

- MIT © [Saad Irfan](https://github.com/msaaddev)
- [Code of Conduct](https://github.com/msaaddev/create-foss-files/blob/master/code-of-conduct.md)

---
_Source: https://npm.io/package/create-foss-files · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
