Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msaaddev/create-foss-files
⌛️ Get all the files you need for an open-source project using `npx create-foss-files`
https://github.com/msaaddev/create-foss-files
automation foss open-source open-source-files template
Last synced: 8 days ago
JSON representation
⌛️ Get all the files you need for an open-source project using `npx create-foss-files`
- Host: GitHub
- URL: https://github.com/msaaddev/create-foss-files
- Owner: msaaddev
- License: mit
- Created: 2021-06-30T21:21:26.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-23T13:44:23.000Z (over 3 years ago)
- Last Synced: 2024-04-24T01:02:06.229Z (7 months ago)
- Topics: automation, foss, open-source, open-source-files, template
- Language: JavaScript
- Homepage: https://twitter.com/msaaddev
- Size: 114 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
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.
- **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.
## ⚡️ Other Projects
I have curated a [detailed list](https://github.com/msaaddev/open-source) of all the open-source projects I have authored. Do take out a moment and take a look.
## 🔑 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)