spin-it

spin-it is a command-line tool that automates the setup of project boilerplates for various technology stacks. It aims to simplify the process of starting new projects by generating the necessary files, directories, and configurations based on user preferences.

Features

• Interactive prompts for selecting programming language, framework, and database
• Generates project structure and boilerplate code based on selected options
• Supports multiple programming languages, frameworks, and databases
• Modular architecture for easy extensibility and maintenance
• Integration with templating engines for dynamic code generation

Getting Started

Install node & npm if you don't have them.

Use npm to install spin-it globally, so you can spin up a stack from anywhere on your computer.

npm install -g spin-it-cli

Create a new folder for your project, open up a terminal in your folder... and...

Spin it!

spin-it

spin-it will take you through choices to choose your stack

You can also pass command-line arguments to spin-it for a quicker setup:

Example:

spin-it --language node --framework express --database mongodb

spin-it will automatically generate a

Installing for devs

1. Clone the repository:

git clone https://github.com/yourusername/spin-it.git

Navigate to the project directory:

cd spin-it

(or wherever )

2. Install the dependencies:

npm install

To start the spin-it setup process, run the following command:

npm run start

Follow the interactive prompts to select your desired programming language, framework, and database. spin-it will generate the project boilerplate based on your selections.

Configuration

spin-it uses a modular architecture with separate configuration files for languages, frameworks, and databases. You can find the configuration files in the config/ directory.

languages.js: Configure the supported programming languages and their specific settings. frameworks.js: Configure the supported frameworks for each language and their specific settings. databases.js: Configure the supported databases and their specific settings.

Customization

spin-it provides a templating system to customize the generated boilerplate code. The template files are located in the templates/ directory, organized by language and framework.

To modify the generated code, you can edit the corresponding template files using the templating syntax supported by the chosen templating engine (e.g., Mustache.js).

Contributing

Contributions are welcome! If you'd like to contribute to spin-it, please follow these steps:

Fork the repository Create a new branch (git checkout -b feature/your-feature) Commit your changes (git commit -am 'Add your feature') Push to the branch (git push origin feature/your-feature) Open a pull request Please make sure to follow the coding conventions and provide appropriate documentation for your contributions.

Roadmap

☐ Add support for more programming languages and frameworks
☐ Integrate with popular APIs and services for enhanced functionality
☐ Implement a plugin system for extensibility
☐ Improve error handling and validation
☐ Enhance the user interface and experience

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

If you have any questions, suggestions, or feedback, please feel free to reach out:

Email: [email protected]
Twitter: @Nominus9
GitHub: sleeperb-cs

Let's make project setup a breeze with spin-it! 🚀