Best Practices for Contributing + First PR Ideas

[srothst1]

Hi 3dstreet! Over the past few days, I have been looking through your repository. I am super impressed and would love to contribute in some small way. Any suggestions for a great beginner PR? I two ideas that I came up with:

• A "free-roam" camera setting. It would be great if users could explore the 3D street layout that they import from more than one angle. I think letting users use the W,A,S,D to move the camera and the mouse to pan the camera would be perfect.
• Adding support for cyclists https://github.com/3DStreet/3dstreet/issues/80
• I also wish that there were more resources about the best practices for open source contributions and questions. This could also be a good place for me to start

cc: @kfarr

[kfarr]

Hi Sam, thanks for the interest! Quick answer is it's probably easiest to do an intro call and we could use the collaboration as a start for public facing docs for contributing. I'll reach out directly to schedule some time and we can keep this ticket open until there are some better docs published.

[srothst1]

@kfarr sounds great! I am looking forward to hearing from you. Please let me know if you need my contact information. :grinning:

I kept investigation "free roam" camera controls. It looks like the following cameraRig configuration in index.html gives the user some basic free-roaming abilities.

<a-entity id="cameraRig">
    <a-entity id="camera" wasd-controls="enabled: true" orbit-controls="enabled: true"></a-entity>
</a-entity>

I think this really adds to the user experience - I'd love to add something like this to the 3D streets spec. Ideally, users should be able to select from a variety of camera modes. Here is a quick video that I put together that showcases the user experience: https://youtu.be/H63M3es3FNo

An immersive web app will give city planners a better feel for their project proposal. It will also give them a sharable experience that they can provide for clients.

[srothst1]

Here is an interesting and somewhat relevant article about a Bay Area legend: https://www.mercurynews.com/2021/05/06/meet-mr-barricade-the-bay-areas-most-unlikely-tik-tok-star-and-new-urbanist-influencer/ Folks like Crossroad Lab CEO Vignesh Swaminathan might love this tech!

[kfarr]

This is great, thanks for all this! A couple notes to start the discussion.

The 3D Street app is made up of 3 separate but related modules: (1) the A-Frame street component (source: https://github.com/3DStreet/3dstreet/) (2) the 3dstreet-editor repo which powers the main 3D Street "app" https://app.3d.st/ (source: https://github.com/3DStreet/3dstreet-editor)* (3) the 3dstreet-assets repo, a work in progress to standardize all 3dstreet assets source and combined glb builds in one repo (https://github.com/3DStreet/3dstreet-assets) (eventually this repo should be CDN'd to assets.3d.st)

*The 3dstreet-editor (2) repo is private at the moment because it has firebase deploy info. I can pull that out and share, or at least add you as a collaborator in the short-term.

The street component (1) is designed for ease of integration with custom A-Frame projects especially for use with glitch.com for rapid creation of projects and sharing with others. Here are a few examples:

• https://17thpreso.glitch.me/#0
• https://glitch.com/edit/#!/aframe-curve-camera
• https://aframe-curve-camera-scroll.glitch.me/

Also I sent you a message via Twitter but you can also contact me at [email protected] to find a time to chat

[srothst1]

@kfarr amazing! Thanks for the additional resources. I just replied to your message on Twitter - let's set up a time ASAP.

[srothst1]

Put together a quick text document about my experience using 3dstreet and streetmix... nothing serious just wanted to write down my process and thoughts.

https://github.com/srothst1/srothst1/blob/main/3DStreet.md

[kfarr]

This is a great writeup, thanks Sam! Some of this feedback could be the foundation for some of your contributions. Good news around some of these that we already have finished models ready to go, such as pedestrians, a food "trailer", and a few more vehicles! Also for discussion: https://aframe-3dtiles-polycam-cesium.glitch.me/

Looking forward to chatting tomorrow

[srothst1]

I may not have the necessary permissions to create a new branch:

srothstein@CSM-4ZBPCB3-Linux:~/Desktop/3dstreet$ git push --set-upstream origin sidewalk-support-2.0
remote: Permission to 3DStreet/3dstreet.git denied to srothst1.
fatal: unable to access 'https://github.com/3DStreet/3dstreet.git/': The requested URL returned error: 403

We can discuss shortly :+1:

[srothst1]

Update: I need to fork the repository before creating a branch.