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 url routing - open scripts from browser location url #70

Closed
artfwo opened this issue May 16, 2018 · 7 comments
Closed

add url routing - open scripts from browser location url #70

artfwo opened this issue May 16, 2018 · 7 comments
Labels
enhancement New feature or request

Comments

@artfwo
Copy link
Member

artfwo commented May 16, 2018

and update the location url when a script is opened from the editor.

@artfwo artfwo added enhancement New feature or request good first issue Good for newcomers labels May 16, 2018
@ngwese ngwese removed the good first issue Good for newcomers label May 16, 2018
@ngwese
Copy link
Member

ngwese commented May 16, 2018

i believe implementing this requires the introduction of a "router" (possibly https://reacttraining.com/react-router/) and as a result there are some potentially non-trivial changes to the application to make it work - but definitely doable.

@jlmitch5 jlmitch5 changed the title open scripts from browser location url add url routing - open scripts from browser location url May 24, 2018
@jlmitch5
Copy link
Collaborator

jlmitch5 commented May 24, 2018

what are all the routes we want?

Ideas:

  • /maiden/scripts/:script_name?tree_view_open={true|false}
  • /maiden/config

@pq
Copy link
Collaborator

pq commented May 24, 2018

@ngwese : what were you thinking about norns docs (api, etc)? some way to read docs inline would be great imo. if we did that maybe another route there?

otherwise, maybe routes for the repl(s)?

@ngwese
Copy link
Member

ngwese commented May 24, 2018

currently the only defined routes are:

url what
/ redirects to /maiden
/maiden the actual editor app
/doc static luadoc generated content served as is, not part of maiden
/api/... backend support for maiden

the above suggestions for script/... or config would be relative to the /maiden root

as far as how the docs/reference get integrated i haven't thought too far ahead. i don't personally have a strong desire to see a ton of documentation hosted directly from the device for space and for maintenance reasons. i do think it is useful to imagine some level of api documentation integrated into the editor (particularly for the lua code which not directly visible in the editor).

@jlmitch5
Copy link
Collaborator

thanks for the clarification (also I'll check out the doc endpoint, didn't realize that was a thing). I've updated my comment.

@pq pq mentioned this issue Jun 7, 2018
@ryanlaws
Copy link
Contributor

What are the opinions on this now? Specifically I'm wondering what the static paths would look like. I'm thinking below /maiden there'd just be a /dust, so that e.g. awake.lua would work out to http://norns.local/maiden/dust/awake/awake.lua. For now, we could just handle paths starting with /maiden/dust/.

@ngwese ngwese closed this as completed in 7c2440e Oct 19, 2019
@ngwese
Copy link
Member

ngwese commented Oct 19, 2019

Support for script URLs is now in master thanks to @ryanlaws

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants