open-source-smith

1.3.0 • Public • Published

Open Source Smith

Open Source Smith is a CLI tool designed to help you quickly set up various types of starter kits for your projects, including backend, frontend, and full-stack configurations.

Table of Contents

Installation

To install Open Source Smith, you need to have Node.js and npm installed on your machine. Then, you can install the package globally using:

npm install -g open-source-smith

Usage

  • After installation, you can use the CLI tool to generate different types of starter kits. For example:
open-source-smith forge
  • To use a specific GitHub repository as a template:
open-source-smith forge --from "username@template-name"

user@template-name can be found at OpenSourceSmith - Templates

Commands

  • forge : Initialize a new open-source project
    • --from <template> : Use a specific OpenSourceSmith template

Project Types

  1. FrontendKit
    • React
    • Vite
    • NextJS
  2. BackendKit
    • Express with TypeScript
  3. FullStackKit
    • Express as backend
    • NextJS Full Stack
Usage: open-source-smith [options] [command]

A CLI tool for managing open-source projects

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  forge            Initialize a new open-source project
  help [command]  display help for command

Contributing

Contributions are always welcome! Please read the contribution guidelines first.

License

This project is licensed under the ISC License - see the LICENSE file for details.

Package Sidebar

Install

npm i open-source-smith

Weekly Downloads

0

Version

1.3.0

License

ISC

Unpacked Size

42.1 kB

Total Files

36

Last publish

Collaborators

  • mdabidhussain