Logic Platform Shared 🚀

A TypeScript library providing shared platform functionality for Team Hitori projects.

🎯 Purpose

Logic Platform Shared provides core shared functionality for platform integration across Team Hitori projects.

📦 Installation

npm install @teamhitori/logic-platform-shared

🚀 Quick Start

Basic Usage

import { storage } from '@teamhitori/logic-platform-shared';

// Use the storage object
console.log(storage);

📡 API Reference

storage

An object providing shared storage functionality.

export const storage: {};

🏗️ Development Setup

Prerequisites

• Node.js 18.x or higher
• npm or yarn package manager

Local Development

1. Clone the repository

   git clone https://github.com/teamhitori/logic-platform-shared.git
   cd logic-platform-shared

2. Install dependencies

   npm install

3. Build the project

   npm run build

Available Scripts

• npm run build - Build the TypeScript project
• npm run build:watch - Build with watch mode
• npm run clean - Clean build artifacts
• npm test - Run tests

🚀 CI/CD & Publishing

The project uses GitHub Actions for automated building and publishing:

Branch Strategy

• main - Stable branch, no automatic actions
• feature/* - Feature branches trigger build-only workflow
• release/* - Release branches trigger prerelease → approval → stable release

Release Process

1. Create release branch

   git checkout -b release/v0.0.1
   git push origin release/v0.0.1

2. Automatic prerelease - GitHub Actions will:

   • Build and test the code
   • Publish prerelease to npm with unique version
   • Create GitHub prerelease
   • Wait for manual approval

3. Manual approval - Review and approve in GitHub Actions

4. Stable release - After approval:

   • Publishes stable version to npm
   • Creates GitHub release
   • Uses version from package.json

Version Management

Update version in package.json before creating release branch:

{
  "version": "0.0.1"
}

📄 License

MIT License - see LICENSE file for details.

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📞 Support

• 📧 Issues: GitHub Issues
• 📖 Documentation: GitHub Wiki
• 💬 Discussions: GitHub Discussions

Made with ❤️ by Team Hitori