https://github.com/achadha235/kitty-hats-manifest

https://github.com/achadha235/kitty-hats-manifest

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/achadha235/kitty-hats-manifest
• Owner: achadha235
• Created: 2018-01-19T00:02:53.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-25T21:10:45.000Z (almost 7 years ago)
• Last Synced: 2024-04-15T02:48:45.644Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 26 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# kitty-hats-manifest

![alt text](https://travis-ci.org/achadha235/kitty-hats-manifest.svg?branch=master "Logo Title Text 1")

The manifest serves as the central repository for listing artists and items and assoicated metadata.

## Adding a new item for an existing artist (internal)

Suppose KittyHawk makes a new item and we want to add it to the repo.

1. Get `@jordan` to make you a contract and send you the JSON. Follow instructions on `kitty-hats-contracts` repo to add your new contract.

2. Find the folder for the artist and open manifest file

3. Place the item asset and preview in the appropriate folders

4. Add an entry for the new item

```

{

	"image": "bowtie",

	"contract": "ItemBowtie",

	"category": "accessories",

	"displayName": "Bowtie",

    "charity": "Pussyhats.org"

}

```

## Adding a new item for an external artist

0. Get the artist to update their repo

1. Should be as simple as running `git submodule update --recursive` for artists with external repos.

## Adding a new artist

New artists need to provide a public repository URL with a repository structure matching the `artists/KittyHawk` folder. Must have an `asset` and `preview` folder with a well-defined `manifest.json`.

2. Ensure that the artist's repository meets the requirements for KittyHats

3. Inside the repo folder, add the artists repository as a submodule 

	`git submodule add  --path ./artists/`

    

    This will clone the repository and update the artists folder.