Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add interactive features to request and select symbols #31

Open
SteveALee opened this Issue Feb 12, 2019 · 8 comments

Comments

Projects
None yet
3 participants
@SteveALee
Copy link
Contributor

commented Feb 12, 2019

The original straight-street website which held the Mulberry symbols provided several interactive features for managing the symbols

  • A process aimed mainly at Speech and Language Therapists to request and review new symbols.
  • Users could select a subset symbols by browsing or search for tag / category and download as a zip
  • A set of symbol translations and ability to select the users prefered language (names, not localised symbols)
  • A RESTful API encouraging innovative apps that use the symbols online

These were all dropped on the copyright assignment and the related move to mulberry-symbols.org. The idea was to keep everything light weight until new requirments and or funding arose. Plus the codebase had an enourmous amount of technical debt.

Let's discuss what similar features might be useful and how to add them....

@SteveALee

This comment has been minimized.

Copy link
Contributor Author

commented Feb 12, 2019

@gavinhenderson

This comment has been minimized.

Copy link
Contributor

commented Feb 12, 2019

I feel like it might be useful to follow a similar model to FontAwesome when it comes to making these symbols available to developers for their innovate apps. I can go into more detail about how I see this working for us if that helps?

@SteveALee

This comment has been minimized.

Copy link
Contributor Author

commented Feb 13, 2019

Do tell! It's a mature package and is popular so they are probably doing something right.

Made me think a npm package is probably as useful as an REST API these days. Especially as buildtime resource acquisition often beats run time (eg static sites)

@eadraffan

This comment has been minimized.

Copy link

commented Feb 13, 2019

@gavinhenderson

This comment has been minimized.

Copy link
Contributor

commented Feb 13, 2019

There would be 1 centralized symbols repo and its only concern is to add new symbols. Every time this repo is altered it would trigger releases of all of the distributions.

There would then be multiple distribution versions such as Vanilla JS, React, Vue, and many more. They would all come in their own git repo and be totally automated. You can then expand your distributions really easily and not have to worry about keeping the symbols up to date.

Personally I would rather get the symbols in an NPM package rather than a REST API if I was developing a website, but I think that might be personal preference more than anything.

@SteveALee

This comment has been minimized.

Copy link
Contributor Author

commented Feb 14, 2019

@gavinhenderson Do we actually need version for different frameworks? I'd like to avoid that if required as even if autmated it's complexity to manage. Would a plain Module of the right type (ES now?) not work almost everywhere Web front end now a days. We could perhaps provide sample wrappers. Needs more discussion.

@gavinhenderson

This comment has been minimized.

Copy link
Contributor

commented Feb 16, 2019

Yeah that is a good point. I think having simple wrappers for different frameworks does add value as it removes all work for the end developer. I think making the library super easy to use can really increase usage of the package.

That being said I agree with you it does add unnecessary complexity to the automation so they can be ignored for now and examples of how to use it in different frameworks would suffice. Then maybe they can be reconsidered once at a later date.

@SteveALee

This comment has been minimized.

Copy link
Contributor Author

commented Mar 15, 2019

I just realised that now we have a web page of all the symbols you can individually download any symbols you like

It's not ideal as the symbols name gets lost but acts as a temp workaround.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.