@teameights/types

Unified TypeScript type definitions for TeamEight's backend and frontend.

Introduction

@teameights/types is the central hub for all TypeScript type definitions and interfaces used across TeamEight's backend and frontend projects. By maintaining a single, consolidated source of truth for our type declarations, we ensure consistency, reduce redundancy, and streamline our development workflow.

Features

• 🧩 Comprehensive Collection: Covers a wide range of type definitions essential for both backend and frontend development.

• ⚙️ Modular Design: Organized modules allow you to import only the types you need.

• 🔄 Consistency Assured: Maintain a consistent development experience across all TeamEight projects.

• 📦 Seamlessly Integrated: Designed to be easily integrated with existing and new projects.

Installation

To add @teameights/types to your project:

npm install @teameights/types --save

Or if you use Yarn:

yarn add @teameights/types

Usage

After installation, you can easily import and utilize the types in your TypeScript files:

import type { UserType, TeamType } from '@teameights/types';

// Your TypeScript logic here...

Contributing

We value and appreciate pull requests from the community. To contribute:

1. Fork the repository.
2. Create a new branch (feature/newType, fix/typeError, etc.).
3. Make your changes.
4. Write tests to validate your changes (if applicable).
5. Commit and push to your forked repository.
6. Open a pull request against @teameights/types.
7. Please ensure that your code follows the existing style conventions and passes linting checks.

Support

If you encounter issues or have questions, please open an issue on our GitHub repository.

License

This project is have private LICENSE. For more details, see the LICENSE file in the repository.