https://github.com/allusion-app/Allusion

A free and open source desktop application for managing your visual library
https://github.com/allusion-app/Allusion

art desktop-application electron image-organization typescript visual-library

Last synced: 3 months ago
JSON representation

A free and open source desktop application for managing your visual library

• Host: GitHub
• URL: https://github.com/allusion-app/Allusion
• Owner: allusion-app
• License: gpl-3.0
• Created: 2019-01-04T15:41:29.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-23T18:28:11.000Z (about 1 year ago)
• Last Synced: 2024-10-12T01:30:57.407Z (7 months ago)
• Topics: art, desktop-application, electron, image-organization, typescript, visual-library
• Language: TypeScript
• Homepage:
• Size: 29.5 MB
• Stars: 679
• Watchers: 17
• Forks: 44
• Open Issues: 83
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/allusion-app/Allusion.svg?token=a7yw4czL1Lye2zty617R&branch=master)](https://travis-ci.com/allusion-app/Allusion)



Allusion is a tool built for artists, aimed to help you organize your **Visual Library** – A single place that contains your entire collection of references, inspiration and any other kinds of images.

[Read more about Allusion →](https://allusion-app.github.io/)

## Installation

Find the latest version of Allusion on the [Releases](https://github.com/allusion-app/Allusion/releases) page.

The application can be automatically updated when a new version becomes available.

## Development

### Quick Start

You need to have [NodeJS](https://nodejs.org/en/download/) and a package manager such as [Yarn](https://yarnpkg.com/lang/en/docs/install/) installed.

Then run the following commands to get started:

1. Run `yarn install` to install or update all necessary dependencies.

2. Run `yarn dev` to build the project files to the `/build` directory. This will keep running to immediately build changed files when they are updated.

3. In a second terminal, run `yarn start` to start the application. Refresh the window (Ctrl/Cmd + R) after modifying a file to load the updated build files.

### Release Build

An installable executable can be built using `yarn package` for your platform in the `/dist` folder. The building is performed using the [electron-builder](https://www.electron.build/) package, and is configured by a section in the `package.json` file.

Builds are automatically published to Github Releases when a tag is created in GitHub.

## Further Information

Anything related from documentation to frequently asked questions can be found in our [wiki](https://github.com/allusion-app/Allusion/wiki).