{"id":20507988,"url":"https://github.com/specklesystems/specklehackathon-specklereports","last_synced_at":"2025-03-05T22:08:09.893Z","repository":{"id":103426642,"uuid":"410873869","full_name":"specklesystems/SpeckleHackathon-SpeckleReports","owner":"specklesystems","description":"Retreat Hackathon: Automated carbon cost reports with real-time notifications","archived":false,"fork":false,"pushed_at":"2022-04-26T10:05:04.000Z","size":14051,"stargazers_count":16,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-01T13:45:45.757Z","etag":null,"topics":["aec","carbon","hackathon","speckle"],"latest_commit_sha":null,"homepage":"https://speckle.systems/blog/retreat-hackathon-carbon-report-app/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/specklesystems.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-09-27T12:23:15.000Z","updated_at":"2024-05-06T15:48:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"917ac3fe-a3b9-476f-96d3-4d078b113f95","html_url":"https://github.com/specklesystems/SpeckleHackathon-SpeckleReports","commit_stats":{"total_commits":16,"total_committers":2,"mean_commits":8.0,"dds":0.3125,"last_synced_commit":"e242ede10bebec65fbddd40cf204df901156e537"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/specklesystems%2FSpeckleHackathon-SpeckleReports","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/specklesystems%2FSpeckleHackathon-SpeckleReports/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/specklesystems%2FSpeckleHackathon-SpeckleReports/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/specklesystems%2FSpeckleHackathon-SpeckleReports/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/specklesystems","download_url":"https://codeload.github.com/specklesystems/SpeckleHackathon-SpeckleReports/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242111444,"owners_count":20073434,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aec","carbon","hackathon","speckle"],"created_at":"2024-11-15T20:16:23.514Z","updated_at":"2025-03-05T22:08:09.866Z","avatar_url":"https://github.com/specklesystems.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/2679513/131189167-18ea5fe1-c578-47f6-9785-3748178e4312.png\" width=\"150px\"/\u003e\u003cbr/\u003e\n  Speckle | Oct'21 Hackathon\n\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003e\n    Report Generator — A carbon cost estimator tool\n\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\u003cb\u003eSpeckle\u003c/b\u003e is data infrastructure for the AEC industry.\u003c/p\u003e\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://twitter.com/SpeckleSystems\"\u003e\u003cimg src=\"https://img.shields.io/twitter/follow/SpeckleSystems?style=social\" alt=\"Twitter Follow\"\u003e\u003c/a\u003e \u003ca href=\"https://speckle.community\"\u003e\u003cimg src=\"https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community\u0026amp;style=flat-square\u0026amp;logo=discourse\u0026amp;logoColor=white\" alt=\"Community forum users\"\u003e\u003c/a\u003e \u003ca href=\"https://speckle.systems\"\u003e\u003cimg src=\"https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square\" alt=\"website\"\u003e\u003c/a\u003e \u003ca href=\"https://speckle.guide/dev/\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square\u0026amp;logo=read-the-docs\u0026amp;logoColor=white\" alt=\"docs\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n# About Speckle\n\nWhat is Speckle? Check our ![YouTube Video Views](https://img.shields.io/youtube/views/B9humiSpHzM?label=Speckle%20in%201%20minute%20video\u0026style=social)\n\n### Features\n\n- **Object-based:** say goodbye to files! Speckle is the first object based platform for the AEC industry\n- **Version control:** Speckle is the Git \u0026 Hub for geometry and BIM data\n- **Collaboration:** share your designs collaborate with others\n- **3D Viewer:** see your CAD and BIM models online, share and embed them anywhere\n- **Interoperability:** get your CAD and BIM models into other software without exporting or importing\n- **Real time:** get real time updates and notifications and changes\n- **GraphQL API:** get what you need anywhere you want it\n- **Webhooks:** the base for a automation and next-gen pipelines\n- **Built for developers:** we are building Speckle with developers in mind and got tools for every stack\n- **Built for the AEC industry:** Speckle connectors are plugins for the most common software used in the industry such as Revit, Rhino, Grasshopper, AutoCAD, Civil 3D, Excel, Unreal Engine, Unity, QGIS, Blender and more!\n\n### Try Speckle now!\n\nGive Speckle a try in no time by:\n\n- [![speckle XYZ](https://img.shields.io/badge/https://-speckle.xyz-0069ff?style=flat-square\u0026logo=hackthebox\u0026logoColor=white)](https://speckle.xyz) ⇒ creating an account at\n- [![create a droplet](https://img.shields.io/badge/Create%20a%20Droplet-0069ff?style=flat-square\u0026logo=digitalocean\u0026logoColor=white)](https://marketplace.digitalocean.com/apps/speckle-server?refcode=947a2b5d7dc1) ⇒ deploying an instance in 1 click\n\n### Resources\n\n- [![Community forum users](https://img.shields.io/badge/community-forum-green?style=for-the-badge\u0026logo=discourse\u0026logoColor=white)](https://speckle.community) for help, feature requests or just to hang with other speckle enthusiasts, check out our community forum!\n- [![website](https://img.shields.io/badge/tutorials-speckle.systems-royalblue?style=for-the-badge\u0026logo=youtube)](https://speckle.systems) our tutorials portal is full of resources to get you started using Speckle\n- [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=for-the-badge\u0026logo=read-the-docs\u0026logoColor=white)](https://speckle.guide/dev/) reference on almost any end-user and developer functionality\n\n![Untitled](https://user-images.githubusercontent.com/2679513/132021739-15140299-624d-4410-98dc-b6ae6d9027ab.png)\n\n# Repo structure\n\nThis repo contains the code for the a **carbon cost report generator** developed on a 1-day hackathon during our company retreat on October 2021.\n\n[**We wrote a blog post about it!**]()\n\n\u003e Go see the app live [here](https://stupefied-yonath-58869c.netlify.app/)\n\nIt is divided into 2 folders:\n\n- `frontend/`: A `vue.js` application allowing to setup carbon report generation for any stream, and view the resulting report.\n- `server/`: A `FastAPI` Python server that receives notifications of each new commit in a stream, and generates a carbon report based on the data.\n\n## Frontend\n\nFirst, install all necesary dependencies by running `npm install` on the `frontend/` folder.\n\nInside the `frontend/` folder, you'll find a file named `.env.local-example`. Rename it to `.env.local` and fill in the variables accordingly.\n\n\u003e The app ID and app secret are obtained when creating a new app in your [Speckle profile section](https://speckle.xyz/profile).\n\nThen run `npm run serve` to run the app in development mode.\n\nTo build the app run `npm run build`\n\n## Server\n\nTo run the app, use the provided `Dockerfile`\n\nTo run the app, create a `.env` file based on the `.env_example`, and pass that to docker run via the `--env-file` flag\n\nFor debug see the `.vscode/launch.json` for a sample config.\n\nUse the example hooks provided, and the `http://localhost:8000/docs` page to test things.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspecklesystems%2Fspecklehackathon-specklereports","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspecklesystems%2Fspecklehackathon-specklereports","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspecklesystems%2Fspecklehackathon-specklereports/lists"}