1.0.1 ā€¢ Published 2 months ago

workspace-spinner v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

šŸŒ€ Workspace Spinner

GitHub Actions Workflow Status GitHub commit activity GitHub package.json version GitHub search hit counter GitHub search hit counter

šŸš€ Effortlessly spin up new JavaScript project workspaces with just a few commands! Workspace Spinner is your CLI companion to weave together Yarn workspaces, ESLint, Prettier, Husky, and more, into a ready-to-code project structure. šŸ› ļøāœØ

šŸ“– Description

Workspace Spinner is designed to simplify the initial setup process for developers, whether you're creating a web app, building a library, or starting a new side project. With a focus on modern JavaScript environments, this tool automates the mundane tasks, letting you dive straight into the creative part of development.

šŸŽ„ Demo

Workspace Spinner Demo Workspace Spinner Demo Workspace Spinner Demo

Watch Workspace Spinner in action as it sets up a new project workspace. The demo illustrates how quickly and seamlessly you can get from zero to a fully configured development environment.

šŸš€ Features

  • Yarn Workspace Setup: Organize your project with Yarn workspaces for better dependency management.

  • Coding Standards: Integrate ESLint and Prettier to maintain a consistent coding style.

  • Git Hooks: Utilize Husky to enforce code quality checks before commits and pushes.

  • Quick Start: Jumpstart your project with pre-configured settings, minimizing the initial boilerplate.

šŸ“¦ Installation

yarn global  add  workspace-spinner

Or if you prefer, you can clone the repository and run it locally:

git clone  https://github.com/jacobwi/workspace-spinner.git



cd  workspace-spinner

yarn install

šŸš€ Usage

Navigate to your project directory and run:

workspace-spinner init

Follow the interactive prompts to configure your workspace!

šŸ› ļø Development

Want to contribute? Great! Workspace Spinner is a work in progress, and we welcome contributions from the community. Here's how you can help:

Fork the repo

Create a new feature branch (git checkout -b feature/AmazingFeature)

Commit your changes (git commit -am 'Add some AmazingFeature')

Push to the branch (git push origin feature/AmazingFeature)

Open a new Pull Request

šŸ“ License

This project is MIT licensed.

āš ļø Note: This project is a work in progress. Features are subject to change, and contributions are warmly welcomed!