https://github.com/vilicvane/magicspace

Toolkit for living boilerplate.
https://github.com/vilicvane/magicspace

boilerplate

Last synced: 20 days ago
JSON representation

Toolkit for living boilerplate.

• Host: GitHub
• URL: https://github.com/vilicvane/magicspace
• Owner: vilicvane
• License: mit
• Created: 2018-07-05T08:52:22.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-07T04:45:04.000Z (about 1 year ago)
• Last Synced: 2024-11-30T15:41:56.991Z (23 days ago)
• Topics: boilerplate
• Language: TypeScript
• Homepage:
• Size: 2.58 MB
• Stars: 32
• Watchers: 6
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![MIT License](https://img.shields.io/badge/license-MIT-999999?style=flat-square)](./LICENSE)

[![Discord](https://img.shields.io/badge/chat-discord-5662f6?style=flat-square)](https://discord.gg/vanVrDwSkS)

# Magicspace

Toolkit for living boilerplate.

## Features

- Composable boilerplate mechanism.

- Git-powered conflict resolution for boilerplate update.

## Installation

```bash

npm install --global magicspace

# Install a boilerplate package

npm install --global @mufan/code-boilerplates

```

## Usage

### Initialize

1. Initialize Git repository.

2. Create magicspace configuration file:

   ```bash

   # Assuming you have installed both `magicspace` and `makeflow/mufan-code-boilerplates` globally.

   magicspace create @mufan/code-boilerplates/typescript --schema

   ```

   Review the generated `.magicspace/boilerplate.json` file and make relevant changes.

3. Initialize magicspace:

   ```bash

   magicspace init

   ```

   Magicspace will generate an initial patch and merge it into the current branch without committing changes.

4. Review generated changes, resolve conflicts if any (probably none as we are initializing an empty project).

5. Commit changes to complete the merge process initiated by magicspace; otherwise use `git merge --abort` to abort the initialization.

   You would probably want to abort the merge process and initialize magicspace again if you need to make other changes to the configuration file during this process.

### Update

1. After updating the boilerplate package or making changes to the magicspace configuration file:

   ```bash

   magicspace update

   ```

   Magicspace will generate an update patch and merge it into the current branch without committing changes.

2. Review generated changes and resolve conflicts if any.

3. Commit changes to complete the merge process initiated by magicspace; otherwise use `git merge --abort` to abort the update.

## Boilerplate authoring

### Examples

- [Boilerplate URL](packages/boilerplate-url)

- [Mufan Code Boilerplates](https://github.com/makeflow/mufan-code-boilerplates)

## License

MIT License.