https://github.com/dappnode/schemas

https://github.com/dappnode/schemas

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dappnode/schemas
• Owner: dappnode
• License: gpl-3.0
• Created: 2023-05-08T12:02:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-10T14:02:24.000Z (about 1 year ago)
• Last Synced: 2024-01-11T18:15:58.842Z (12 months ago)
• Language: TypeScript
• Size: 529 KB
• Stars: 1
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @dappnode/schemas

This package provides JSON schemas for the dappnode files **setup wizard**, **manifest** and **docker-compose** as well as its JSON schema validation functions to ensure the file provided is valid and follows the specifications.

## Installation

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

```bash

npm install @dappnode/schemas

```

## Usage

To utilize the validation functions for the JSON schemas:

```typescript

import {

  validateComposeSchema,

  validateManifestSchema,

  validateSetupWizardSchema,

} from "@dappnode/types";

```

## 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.