Skip to main content

Contributing to 3DStreet

Contributors to 3DStreet can come from various backgrounds, such as 3D artists, programmers, GIS experts, urban planners, educators, and enthusiasts.

Some possible ways to become a contributor are:

  • Application Development: People proficient with JavaScript, A-Frame / Three.js / React etc can help with the development and optimization of 3DStreet. See our primary repository 3DStreet/3dstreet for the open-source 3DStreet editor codebase.
  • 3D modeling: If you're skilled in 3D modeling software (e.g., Blender, 3ds Max, Maya, SketchUp), you can create and contribute 3D models of buildings, street elements, or other urban objects. See 3d modeling guide on 3dstreet-assets-source README. The asset system allows you to upload any 3D model right away, just open the app and drag and drop to use.
  • GIS and mapping: If you have experience with geographic information systems (GIS), you can help improve the geospatial accuracy and detail of the project by incorporating real-world map data or satellite imagery. Here's an example project that leverages 3DStreet for visualization of GIS data: https://github.com/kfarr/zoningviz
  • Documentation and tutorials: Writing documentation, creating tutorials, or making video guides can help newcomers learn how to contribute to the project and use the tools more effectively. You're reading the docs now. It's all based on docusaurus and our 3dstreet-docs repo is here: https://github.com/3DStreet/3dstreet-docs
  • Testing and feedback: Test the existing models, tools, and workflows, and provide feedback to improve the project. There are some tests but not so great coverage. Please feel free to file an issue, the 3DStreet repo is the best to file new issues.
  • Community building: Engage with other contributors, help moderate forums, or organize events to promote the project and bring together people with shared interests. Join our discord.