Skip to content

Track your commissions more efficiently with Komishon!

License

Notifications You must be signed in to change notification settings

erayalkis/komishon

Repository files navigation


Logo

Komishon

Track your art and commissions more efficiently with Komishon!
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About Komishon
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Acknowledgments

About The Project

Komishon Screenshot

Komishon is an app for efficiently tracking commissions while keeping your files organized. With features such as tagging for easy organization, and deadline reports for quick reminders for catching up on work, Komishon makes tracking your projects easier.

Komishon is currently in early development and many features will be updated and changed. Don't forget to give the project a star, as it keeps us motivated to make it better! Thanks again!

(back to top)

Built With

  • Vue
  • Tauri
  • Rust
  • SQLite

(back to top)

Getting Started

Thank you for your interest in using Komishon!

To get started, you can import a folder by using the import button on the top right section of the app. After you import a folder, Komishon will watch it for changes, and apply any changes made to it - and any files inside it -. This means, if you rename a folder, delete any file inside it, rename any file inside it, etc, Komishon will apply those changes instantly.

To favorite a folder or a file, you may use the heart icon on them, or right click on them to favorite through the context menu.

To apply Tags and Deadlines to a file, simply right click on it, and go to the Tags/Deadlines section, where you can find the option to add a new Tag/Deadline.

Installation

To get Komishon running locally, first clone the repo:

git clone git@github.com:erayalkis/komishon.git

Then, navigate to the project's root, and install all the necessary JavaScript packages by running:

npm install

And finally, build and run the app by using:

npm run tauri dev

Prerequisites

To build, test and run the backend code for Komishon, start by installing Rust by following the guide on the offical Rust Website.

Then, ensure that you have the necessary libraries for running Tauri:

On Windows - which is currently the only supported operating system - you will need:

(back to top)

Roadmap

Before v1.0:

  • Add changelogs to releases
  • Refactor code
  • Revamp UI
  • Add notifications

After v1.0:

  • Add drag and drop functionality for moving files
  • Add more actions to context menu
  • Update search functions
  • Improve UI design

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated!

If you have a suggestion that would make Komishon better, please create a new issue, or fork the repo and create a pull request.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License. See LICENSE.md for more information.

(back to top)

Acknowledgments

(back to top)