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

Move packages/examples to main folder #1218

Closed
cblazo opened this issue Apr 3, 2018 · 3 comments
Closed

Move packages/examples to main folder #1218

cblazo opened this issue Apr 3, 2018 · 3 comments

Comments

@cblazo
Copy link

cblazo commented Apr 3, 2018

Description / Steps to reproduce / Feature proposal

Issue #836 brought the examples back into the monorepo (/packages/examples). However, the packages folder is already substantially sized. A suggestion is to make a dedicated examples folder in the main project folder, as these have nothing to do with the actual LoopBack REST API logic in the packages folder, but just show how to get started or work with LoopBack 4.

Current Behavior

The example folders (example-getting-started, example-hello-world, example-log-extension, example-rpc-server) are in the packages folder.

Expected Behavior

The example folders are in the main folder and the packages folder is smaller and more organized.

@dhmlau
Copy link
Member

dhmlau commented Apr 3, 2018

@cblazo , thanks for your feedback. Coincidently, @bajtos had proposed the same thing about a week ago!

..move example projects from packages/example-{name} to examples/{name}. For example, packages/example-rpc-server will be moved to examples/rpc-server

Would you like to submit a PR?

@jwooning
Copy link
Contributor

jwooning commented Apr 4, 2018

I was working in collaboration with @cblazo on submitting a PR but we ran into a problem with the generators in the cli package. The clone-example generator requires downloading this source code which will have the old example structure for now, and thus the clone-example tests fail until the PR is merged. Should I just ignore the failing tests and submit the PR anyway?

@virkt25
Copy link
Contributor

virkt25 commented Apr 4, 2018

@jwooning @cblazo As long as you update the relevant code in the CLI to fetch from the right folder it is OK for some of the tests to fail. That is unfortunately the case any time we have a major refactor such as this one because of how the CLI extracts examples from the monorepo.

Once you have a PR up I can help to land it :) Thank you for the help!

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

No branches or pull requests

4 participants