https://github.com/dappnode/types

https://github.com/dappnode/types

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dappnode/types
• Owner: dappnode
• License: gpl-3.0
• Created: 2023-04-28T12:57:14.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-06T15:54:24.000Z (about 1 year ago)
• Last Synced: 2023-12-07T19:21:10.975Z (about 1 year ago)
• Language: TypeScript
• Size: 445 KB
• Stars: 1
• Watchers: 6
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# @dappnode/types

This package provides a shared collection of TypeScript types, utility functions, parameters, and JSON schemas for DAppNode projects.

## Installation

To add this package as a dependency in your project, use the following command:

```bash

npm install @dappnode/types

```

## Usage

To utilize the shared types, utility functions, parameters, and JSON schemas in your project, simply import them as needed:

```typescript

import { MyType, myUtilityFunction, myParameter } from "@dappnode/types";

```

## Structure

This package is organized as follows:

- `src/types`: Contains the shared TypeScript types.

- `src/utils`: Contains the shared utility functions.

- `src/params`: Contains the shared parameters.

- `src/schemas`: Contains the shared JSON schemas.

## Contributing

1. Fork the repository and clone it to your local machine.

2. Navigate to the project directory and install the dependencies:

   ```bash

   npm install

   ```

3. Make your changes or additions to the code.

4. Build the project:

   ```bash

   npm run build

   ```

5. Commit and push your changes to your fork.

6. Open a pull request to the main repository.

## License

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