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

Create a Codegen REST API #191

Open
manekinekko opened this issue Feb 16, 2019 · 8 comments
Open

Create a Codegen REST API #191

manekinekko opened this issue Feb 16, 2019 · 8 comments

Comments

@manekinekko
Copy link
Member

manekinekko commented Feb 16, 2019

Is your feature request related to a problem? Please describe.
xLayers provides a nice and easy UI for users. But this UI isn't suited for batch codegen nor for other automated tasks.

Describe the solution you'd like
We want to provide a REST API that will allow developers to send in a SketchApp design and get the generated code. The API should support batch codegen.

Additional context

  1. When this gets approved, it should be implemented in a separate repository.
  2. When this gets approved, the UI editor would use this API for the codegen part.
@manekinekko
Copy link
Member Author

manekinekko commented Jul 18, 2019

We will use @nestjs framework for the REST API.

@manekinekko manekinekko self-assigned this Jul 18, 2019
@MrCube42
Copy link
Contributor

@manekinekko Looks interesting to me, I could help (built some REST APIs using Nest). Sure you want this to be in an own repository rather than mono repo? Had good experiences with 2 directory like /frontend and /backend where each has its own package.json in a single repository.

@manekinekko
Copy link
Member Author

Thank you @MrCube42 for this. We were waiting until we publish all different packages to NPM. Eventually, we'd like for this to be in a separate repository.

In the meantime, do you wanna draft a design doc for this before starting the implementation? Please find the design doc template in the wiki section.

@MrCube42
Copy link
Contributor

@manekinekko Sure. I'll have a look and let you know if I had a first draft ready. May take some time though. 🕰

@MrCube42
Copy link
Contributor

@manekinekko I created a design document draft https://docs.google.com/document/d/1PN7eQ8d12JgRusO-1pmVuwJXm2HhsLtp4xRGtwfvxvU/edit?usp=sharing. It is in a very early state. Especially the implementation detail needs more work. I tried to fill in everything I can as a starting point and added some initial ideas. I made it available for commenting.

@manekinekko
Copy link
Member Author

Hey @MrCube42 sorry about this delay.

Your design doc lgtm. Do you still have time to work on a POC? I've created this repo (https://github.com/xlayers/xlayers-backend-nestjs) where we can push your code once you're ready.

Cheers.

@manekinekko manekinekko removed their assignment Mar 24, 2021
@MrCube42
Copy link
Contributor

Hey @manekinekko. Thanks for the feedback and reaching out to me again. It's been a while. I completely forgot about this on my personal backlog 😁 I am very unsure about time and motivation at the moment. However I'll put it into my latest bookmarks and will have a look at it again. To be honest, it has low priority for me at the moment, so anyone should feel free build on top of my very first design doc steps ("First come, first serve"). I'll let you know as soon as I pick it up again or need help. Is that ok for you?

@manekinekko
Copy link
Member Author

No worries at all – that's how open source works!

@manekinekko manekinekko self-assigned this Mar 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants