Skip to content

CLI tool for effortlessly spinning up new TypeScript project workspaces! πŸš€ Easily configure Yarn workspaces, integrate essential development tools like ESLint, Prettier, and Husky. πŸ› οΈβœ¨

Notifications You must be signed in to change notification settings

jacobwi/workspace-spinner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

45 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŒ€ 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!

About

CLI tool for effortlessly spinning up new TypeScript project workspaces! πŸš€ Easily configure Yarn workspaces, integrate essential development tools like ESLint, Prettier, and Husky. πŸ› οΈβœ¨

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published