Giter VIP home page Giter VIP logo

memo_editor's Introduction

memo_editor

A tool to help manage your own memo collections.

This tool wraps a rich-text editor that allows you to (locally) manage and store custom collections, with import/export features to make a seamless experience when dealing with the core project's collection format.

Few things to consider

Before using this tool, be aware that it's in a state that we consider pre-alpha, meaning that it should have a plethora of bugs and visual inconsistencies - really, we didn't put almost any effort while thinking about the layout. The current version is only meant as a PoC of a editor that should make things easier for anyone that wants to create its own collection of memos, or even import one from the core memo project and update with your own personal preferences.

Nonetheless, we are looking into where this tool stands today and where we can go from here to improve the memo ecosystem, you can take a look at this project's issues to get to know what are the next steps.

Setup

If you have no idea how to install Flutter and run it locally, check this Get started.

If you have Flutter setup locally, on the project's root folder, install pubspec dependencies by running flutter pub get and make sure that, if you're not using vscode, to also generate the files through flutter pub run build_runner build. If you're using vscode, it should be all setup, described in details in the section below.

Running Tasks

Because this project's uses build_runner, it's important to know when to use its tasks.

When you open this project, the Generate build_runner files should automatically run but if for some reason the vscode do not, open the vscode Run Build Task (CMD + SHIFT + B shortcut) and run Generate build_runner files.

If you're planning to develop and change any file that auto-generates, open the vscode Run Build Task (CMD + SHIFT + B shortcut) and run Watch build_runner files, or simply launch using the DEV - Tool + Watch configuration of launch.json.

Example Collection Format

Minimal example of a collection, appropriately called my_example_collection.json, holding a single memo:

{
  "id": "my_example_collection",
  "name": "My Example Collection",
  "description": "My description",
  "category": "My category",
  "tags": ["My single tag"],
  "memos": [
    {
      "question": [],
      "answer": []
    },
  ]
}

memo_editor's People

Contributors

matuella avatar

Stargazers

 avatar  avatar Gabriel Carneiro avatar  avatar

Watchers

James Cloos avatar Guilherme Girotto avatar  avatar

Forkers

alanlv

memo_editor's Issues

Add Collections Page

Add the option to manage multiple collections simultaneously, instead of just a single one.

Add bulk operations

Allow the editor to remove, export and import multiple collections in a single operation.

Add a proper interface for the alpha release

As it stands today, the tool is functional but lack a lot on the user experience, as it was made to simply fill an internal problem to deal with collection-generation within the memo project.

We need to make sure that memo_editor also fits the same quality that memo brings to their users, as we eventually plan to release an alpha version that anyone can use to customize its collections and memos, suggest additions to the core memo repository, etcetera.

This also involves adding a bunch of other functionalities that are missing today, like validating the collection properties text fields, responsive layout (with experience-adjusted features for each "major" device size), connecting the existing collections in the memo repository and "bridge" the changes-suggestion in the core repository (using this editor tool), and a lot of other things.

This also brings us one important question (that we are currently evaluating): should we actually merge this editor into the main tool (/memo repository) and diminish the difficulty for new entrants to join the memo ecosystem and start contributing?

Adds release flow

Not necessarily a workflow for this v1, but it must support releasing for macOS and web.

Improve editor experience

Currently, the editor doesn't allow specific-code highlight, do not allow uploading images and has an overall poor text-editing experience, due to some implementation decisions in flutter-quill.

We should look into these issues and, if they prove to be big enough changes, probably fork the flutter-quill and start from there. Creating a brand new project for this is also a valid possibility, given that the code in flutter-quill do not contain any unit test and has almost no documentation, making it hard to update things there.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.