Skip to content
This repository was archived by the owner on Aug 21, 2024. It is now read-only.

Conversation

@jerknose
Copy link
Contributor

@jerknose jerknose commented Feb 4, 2023

Summary

A summary of changes being made in this PR

Hey guys. I created a working prototype of a npx installer. Once published, we'll have a single command to configure everything.

"npx @xrengine/xrengine folder_name"

Then just run "cd folder_name & npm run dev"

Also, there's a GitHub action to auto publish to npm: https://github.com/marketplace/actions/npm-publish

References

closes #insert number here

Checklist

  • If this PR is still a WIP, convert to a draft
  • ensure all checks pass
  • When this PR is ready, mark it as "Ready for review"
  • Changes have been manually QA'd
  • Changes reviewed by at least 2 approved reviewer

QA Steps

To test locally:
Run 'npm i -g'
Run 'npx xrengine folder_name'

@jerknose jerknose self-assigned this Feb 4, 2023
@jerknose jerknose changed the title Working dev install. Working NPX dev config and install. Feb 4, 2023
Copy link
Contributor

@HexaField HexaField left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link
Contributor

@speigg speigg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're in the process of moving everything over from xrengine -> etherealengine namespaces; let's do that here preemptively.

We have an @etherealengine org for npm, perhaps we should do npx @etherealengine/install for this?

@jerknose
Copy link
Contributor Author

jerknose commented Feb 6, 2023

We're in the process of moving everything over from xrengine -> etherealengine namespaces; let's do that here preemptively.

We have an @etherealengine org for npm, perhaps we should do npx @etherealengine/install for this?

The default npx behavior is to use @org_name/repo_name. But I believe we can define multiple scripts in Package.json.

i.e. npx @org_name/repo_name script_name var_1

So, something like this (with the current repo name)

@etherealengine/xrengine install my_engine_folder

@speigg
Copy link
Contributor

speigg commented Feb 6, 2023

The default npx behavior is to use @org_name/repo_name

@jerknose Can you point me to some documentation about this?

@jerknose
Copy link
Contributor Author

@speigg
Copy link
Contributor

speigg commented Feb 14, 2023

Not seeing any reason we can't do npx @etherealengine/install for this; just waiting on npm support to get back to me about the @EtherealEngine npm org, which is being name-squatted right now...

@jerknose
Copy link
Contributor Author

@speigg Can we merge this in as a working template? I think which org name, and repo name are a separate issue.

@speigg speigg added this pull request to the merge queue Feb 16, 2023
Merged via the queue into dev with commit d40c54e Feb 16, 2023
@speigg speigg deleted the feature/npx branch February 16, 2023 17:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants