Skip to content

Commit

Permalink
Add license and readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
franmaranchello committed May 14, 2024
1 parent a92423a commit 7b3e73a
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 e-verse

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Zoidberg AI - Backend

This deploys a Google Cloud Function that serves as the backend for the Zoidberg AI assistant in Revit. It generates code to solve different user requirements that the assistant later runs.
<br/>

If you appreciate the work put into this free tutorial, please leave us a comment on YouTube/Substack.

## Getting Started

For local running, you can use `yarn start`. That will spin up a local server with the endpoint running in `http://localhost:8080/`. Otherwise, deploy this to your GCP account using your deployment keys (check out the tutorial for more info).

Looking to get the Zoidberg AI Addin? Check out [this repo](https://github.com/EverseDevelopment/ZoidbergAI.Addin).

## Contributors

The source idea for this tool originated from the Clippy AI team from the 2023 AEC Tech hackathon in NY. This is a spinoff of that, scaling the concept.

This repo is primarily managed by [e-verse](https://www.e-verse.co/) and by [People Like You™](https://github.com/EverseDevelopment/revit-glTF-exporter/pulse).

## Help improve Zoidberg

If you're interested in contributing to Zoidberg, just submit a [pull request](https://github.com/EverseDevelopment/ZoidbergAI.Backend/pulls) or a [feature request](https://github.com/EverseDevelopment/ZoidbergAI.Backend/issues).

## About us

We are an international mix of AEC professionals, product designers, and software developers. We work together to transform construction requirements into accurate and partnership-driven technological solutions.

<p align="center" width="100%">
<a href="https://www.e-verse.com/">
<img src="https://s3.amazonaws.com/everse.assets/GithubReadme/e-verse_logo_no+slogan.jpg" align="center">
</a>
</p>

0 comments on commit 7b3e73a

Please sign in to comment.