{"id":16140149,"url":"https://github.com/maggieappleton/invenntion","last_synced_at":"2025-03-18T16:31:21.324Z","repository":{"id":104842477,"uuid":"584111530","full_name":"MaggieAppleton/invenntion","owner":"MaggieAppleton","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-09T07:58:08.000Z","size":3157,"stargazers_count":17,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-28T10:53:23.857Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/MaggieAppleton.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-01T12:17:39.000Z","updated_at":"2024-03-16T07:05:26.000Z","dependencies_parsed_at":"2023-06-13T23:55:22.088Z","dependency_job_id":null,"html_url":"https://github.com/MaggieAppleton/invenntion","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaggieAppleton%2Finvenntion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaggieAppleton%2Finvenntion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaggieAppleton%2Finvenntion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaggieAppleton%2Finvenntion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MaggieAppleton","download_url":"https://codeload.github.com/MaggieAppleton/invenntion/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243940132,"owners_count":20372047,"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":[],"created_at":"2024-10-09T23:50:50.293Z","updated_at":"2025-03-18T16:31:21.319Z","avatar_url":"https://github.com/MaggieAppleton.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# How to Run\n\nThis project uses `yarn`, and runs on node 18 (check .nvmrc for the exact version). Run it locally with `yarn dev`.\n\n\u003cbr /\u003e\n\n# Design Brief\n\n## Concept\n\nA venn diagram that combines two concepts or ideas for you. Using a generative language model, we give the user three++ possible ways to combine their initial concepts.\n\nUses OpenAI's GPT-3 to generate ideas.\n\nUsers can save generated results as text or PNGs.\n\n### Initial concept sketch\n\n![](images/sketch2.jpg)\n\n### [Wireframes](/design-process/wireframes.md)\n\n![](images/onboarding.png)\n![](images/main-flow.png)\n\n\u003cbr /\u003e\n\n## [Visual Design Mockups](/design-process/visual-designs.md)\n\n![](images/invenntion2.jpg)\n![](images/invenntion6.jpg)\n![](images/invenntion9.jpg)\n\n\u003cbr /\u003e\n\n## WIP Proof of Concept\n\nBasic functionality working on the prototype\n\n![](images/invenntion-process.jpg)\n\n\u003cbr /\u003e\n\n## Requirements\n\n### Essential\n\nUsers should be able to:\n\n- enter their OpenAI API key to make requests\n  - make sure that API key isn't stored or exposed to 3rd parties\n- enter two words or sentences. Max length 100 characters.\n- click a button/area that triggers the combination action: sends a request to OpenAI\n  - use text-davinici-003\n  - return three options, each less than 180 characters\n- see a loading animation while the request is resolving\n- see the returned results\n- be able to swipe/scroll/click through the three returned results\n- be able to reset the whole venn to be blank\n- be able to edit the existing inputs and re-run the generation\n\n### Nice to have\n\n- be able to generate more than three results\n  - this could be re-running the whole generation, or clicking somewhere to generate a fourth or fifth result in addition to the first three\n- copy generated results to the clipboard\n- save a PNG of the final venn digram with inputs and generated results\n- shared a generated PNG and link to Twitter\n- animated rainbow gradient on venn circles – maybe a requirement 🌈\n\n## Todos\n\n- [x] Wireframe main user flow\n- [x] Wireframe onboarding sequence\n- [x] Final designs that meet all the requirements\n- [ ] Write an example dataset of prompts and good answers to fine-tune on\n- [x] Good enough prompt engineering\n- [ ] Research how we can accept OpenAI keys and use them for API requests without compromising user security\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaggieappleton%2Finvenntion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaggieappleton%2Finvenntion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaggieappleton%2Finvenntion/lists"}