max-itup / content

MaxItUp is a Mac setup tool to create a setup script for newly formatted Mac devices.

Adding new content

This repository serves as the data container for MaxItUp!

data.json

The json file contains two arrays for categories and items, changing this file will change the content in website

{
  "categories": [],
  "items": []
}

Categories

To Add/update or delete categories, please use the following format:

{
    "id": "Category unique identifier (string)",
    "name": "Category name (string)",
    "order": "Category order (int)"
}

Items

To Add/update or delete items, please use the following format:

{
    "id": "Item unique identifier (string)",
    "type": "Item type (cask, brew, gem, os_settings, ...) (string)",
    "name": "Item name (string)",
    "description": "Item description (optional string)",
    "category": "Category unique identifier (should be in categories array, string)",
    "download_url": "URL to download item (optional string)",
    "code": "Item code"
}

Assets

When adding categories/items, please consider adding icons/background images for them

Categories

1. Image name: category.id
2. Image format : .svg
3. Location /assets/categories

Items

1. Image name: item.id
2. Image format : .png
3. Location /assets/items

Thanks

Special thanks to:

• Bashar Ghadanfar coming up with the name MaxItUp! and designing the project's visual identity.

License

MaxItUp is released under the MIT license. See LICENSE for more information.