Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 3.12 KB

README.md

File metadata and controls

92 lines (63 loc) · 3.12 KB
Raw

Artisan v2.0

A content management tool for creating, editing, and publishing responsive Adobe Illustrator embeds. Heavily inspired by and built upon ai2html.

Contents

Why This?

At POLITICO, we use Artisan to manage the workflow involved in creating a custom static embed. Artisan allows its users to easily create embeds, organize them into projects, and then share the embeds with editors before finally publishing them to our website with an embed code.

How's It Work?

Artisan uses a modified version of ai2html to turn Adobe Illustrator files into responsive HTML pages with rasterized images for backgrounds and other flat assets. Artisan also comes with a number of other functions which use file system functions, the AWS API, and more to offer a number of common user actions related to the production of these embeds (e.g. sharing with editors, publishing, duplicating, etc.)

Artisan In Action

Screenshots and more to come...

Installation

  1. Find the install link on our company Notion.
  2. Save the latest version to your downloads folder.
  3. Open the DMG, and copy the Artisan icon into your Applications folder.

Development

Prerequistes

1. CLang and macOS Development Dependencies

xcode-select --install

2. Rust

curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh

Developing The Base App

npm run tauri dev

Developing the Share Bundle

npm run share:dev

You can edit src/share/index.html as your development file.

Deployment

We're currently experimenting with using Tauri's updating feature. Until then, deployments will consist of creating new DMG builds and instructing users to replace their current version with a new one.

To create a new build run

npm run tauri build:universal

You'll then find the DMG in ...

src-tauri/target/universal-apple-darwin/release/bundle/dmg/

Deploying Share Bundle

If you've made a change to the share bundle, first update the version in src/share/version.mjs. The version should match Artisan's version, with the last number being the one you increment. Then run

npm run share:build; npm run share:publish;

Users & Permissions

Artisan uses hermes on the cloud for authenticating users. To add users to the list of authorized Artisan users, add their POLITICO email to this list.

Note: You'll need an AWS profile named publishing configured in your aws credentials files. This will work as expected if you've already set up Loki properly.