Giter Site home page Giter Site logo

jacobwi / workspace-spinner Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 4.2 MB

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

JavaScript 100.00%
cli generator husky inquirer jest monorepo ora react shell spinner structure typescript vite yarn-workspaces

workspace-spinner's Introduction

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

workspace-spinner's People

Contributors

jacobwi avatar

Watchers

 avatar

workspace-spinner's Issues

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch main on the remote Git repository with URL https://x-access-token:[secure]@github.com/jacobwi/workspace-spinner.git.

This can be caused by:


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.