Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snekussaurier/feather-and-ink
Feather&Ink is a visualization tool for your pen&paper character in the world of Aborea. It uses a stack of React.js, Electron and SQLite 3.0.
https://github.com/snekussaurier/feather-and-ink
aborea electron penandpaper react sqlite3
Last synced: about 2 months ago
JSON representation
Feather&Ink is a visualization tool for your pen&paper character in the world of Aborea. It uses a stack of React.js, Electron and SQLite 3.0.
- Host: GitHub
- URL: https://github.com/snekussaurier/feather-and-ink
- Owner: Snekussaurier
- License: apache-2.0
- Created: 2022-08-03T13:31:50.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-24T19:49:20.000Z (over 1 year ago)
- Last Synced: 2023-11-15T09:40:35.563Z (about 1 year ago)
- Topics: aborea, electron, penandpaper, react, sqlite3
- Language: JavaScript
- Homepage: https://snekussaurier.github.io/feather-and-ink/
- Size: 163 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
#### Feather&Ink is a visualization tool for your pen&paper character in the world of Aborea. It uses a stack of React.js, Electron and SQLite 3.0.
# Features
Feather&Ink provides the following features:
- Support for multiple characters
- Characters geting saved locally
- Stats are getting set automatically
# Getting Started
You can get started with Feather&Ink by downloading the corresponding app from the release.
Alternatively you can set up a local development environment.
## Development Environment (Local)
### System Requirements
Before you begin, make sure you have the following installed:
- [Node.js v16 or above](https://nodejs.org/en/download/)
- [Yarn v1.22 or above](https://classic.yarnpkg.com/en/docs/install#windows-stable)
### Initializing all the packages
Feather&Ink is using a monorepo with multiple packages. To initialize all the packages on a local development environment
1. Execute the following commands in the project root folder:
```jsx
yarn install
```
This will install all the required dependencies.
2. Run the development command to start the app:
```jsx
yarn run dev
```
# Version 0.1.0-alpha
Feather&Ink 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.
## Create a bug report
If you see an error message or run into an issue, please [create bug report](https://github.com/snekussaurier/feather-and-ink/issues/new?assignees=&labels=type%3A+bug&template=bug.yaml&title=%F0%9F%90%9B+Bug+Report%3A+). This effort is valued and helps all Feather&Ink users.
## Submit a feature request
If 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=&labels=type%3A+feature+request&template=feature.yml).
If a similar feature request already exists, don't forget to leave a "+1".
If you add some more information such as your thoughts and vision about the feature, your comments will be embraced warmly :)
# Contributing
Feather&Ink 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&Ink community.