workspace-spinner
v1.0.1
Published
π Workspace Spinner - Your go-to CLI tool for effortlessly spinning up new JavaScript project workspaces! π Easily configure Yarn workspaces, integrate essential development tools like ESLint, Prettier, and Husky, and set sail on your coding journey wit
Downloads
3
Maintainers
Readme
π Workspace Spinner
π 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
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!