{"id":18249767,"url":"https://github.com/snekussaurier/feather-and-ink","last_synced_at":"2025-04-04T16:30:54.593Z","repository":{"id":52306681,"uuid":"520893064","full_name":"Snekussaurier/feather-and-ink","owner":"Snekussaurier","description":"Feather\u0026Ink is a visualization tool for your pen\u0026paper character in the world of Aborea. It uses a stack of React.js, Electron and SQLite 3.0.","archived":false,"fork":false,"pushed_at":"2023-09-24T19:49:20.000Z","size":171017,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-20T15:11:47.171Z","etag":null,"topics":["aborea","electron","penandpaper","react","sqlite3"],"latest_commit_sha":null,"homepage":"https://snekussaurier.github.io/feather-and-ink/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Snekussaurier.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-03T13:31:50.000Z","updated_at":"2024-12-18T21:34:28.000Z","dependencies_parsed_at":"2024-11-05T09:53:20.397Z","dependency_job_id":null,"html_url":"https://github.com/Snekussaurier/feather-and-ink","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Snekussaurier%2Ffeather-and-ink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Snekussaurier%2Ffeather-and-ink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Snekussaurier%2Ffeather-and-ink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Snekussaurier%2Ffeather-and-ink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Snekussaurier","download_url":"https://codeload.github.com/Snekussaurier/feather-and-ink/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247209245,"owners_count":20901731,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aborea","electron","penandpaper","react","sqlite3"],"created_at":"2024-11-05T09:41:15.754Z","updated_at":"2025-04-04T16:30:49.582Z","avatar_url":"https://github.com/Snekussaurier.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/Snekussaurier/feather-and-ink/dev/Logo.png\" height=\"180px\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/Snekussaurier/feather-and-ink/actions/workflows/release.yml/badge.svg?style=flat-square\" alt=\"Release CI\"\u003e\n  \u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=flat-square\" alt=\"License\"\u003e\n  \u003c/a\u003e\n  \u003cimg alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/downloads/snekussaurier/feather-and-ink/total.svg?style=flat-square\u0026color=purple\"/\u003e\n\u003c/p\u003e\n\n![Background](https://user-images.githubusercontent.com/68194327/200125328-9e8b291e-b18c-48f0-aa64-6961fee0aed0.png)\n\n#### Feather\u0026Ink is a visualization tool for your pen\u0026paper character in the world of Aborea. It uses a stack of React.js, Electron and SQLite 3.0.\n# Features\n\nFeather\u0026Ink provides the following features:\n\n- Support for multiple characters\n- Characters geting saved locally\n- Stats are getting set automatically\n\n# Getting Started\n\nYou can get started with Feather\u0026Ink by downloading the corresponding app from the release. \n\nAlternatively you can set up a local development environment.\n\n## Development Environment (Local)\n\n### System Requirements\n\nBefore you begin, make sure you have the following installed:\n\n- [Node.js v16 or above](https://nodejs.org/en/download/)\n- [Yarn v1.22 or above](https://classic.yarnpkg.com/en/docs/install#windows-stable)\n\n### Initializing all the packages\n\nFeather\u0026Ink is using a monorepo with multiple packages. To initialize all the packages on a local development environment\n\n1. Execute the following commands in the project root folder:\n\n```jsx\nyarn install\n```\nThis will install all the required dependencies.\n\n2. Run the development command to start the app:\n\n```jsx\nyarn run dev\n```\n# Version 0.1.0-alpha\n\nFeather\u0026Ink is currently in its version 0.1.0-alpha, so it's currently under active development. There are a lot of features, that are missing or aren't fully implemented. We are currently trying to fix those issues as soon as possible.\n\n## Create a bug report\n\nIf you see an error message or run into an issue, please [create bug report](https://github.com/snekussaurier/feather-and-ink/issues/new?assignees=\u0026labels=type%3A+bug\u0026template=bug.yaml\u0026title=%F0%9F%90%9B+Bug+Report%3A+). This effort is valued and helps all Feather\u0026Ink users.\n\n\n## Submit a feature request\n\nIf you have an idea, or you're missing a capability that would make development easier and more robust, please [Submit feature request](https://github.com/Snekussaurier/feather-and-ink/issues/new?assignees=\u0026labels=type%3A+feature+request\u0026template=feature.yml).\n\nIf a similar feature request already exists, don't forget to leave a \"+1\".\nIf you add some more information such as your thoughts and vision about the feature, your comments will be embraced warmly :)\n\n\n# Contributing\n\nFeather\u0026Ink is an open-source project. We are committed to a fully transparent development process and appreciate highly any contributions. Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as part of the Feather\u0026Ink community.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnekussaurier%2Ffeather-and-ink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnekussaurier%2Ffeather-and-ink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnekussaurier%2Ffeather-and-ink/lists"}