Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Lissy93/cheat-code

💫 An AI-powered coding assistant, built to try out the ChatGPT API
https://github.com/Lissy93/cheat-code

chatgpt openai

Last synced: 3 months ago
JSON representation

💫 An AI-powered coding assistant, built to try out the ChatGPT API

Host: GitHub
URL: https://github.com/Lissy93/cheat-code
Owner: Lissy93
Created: 2023-03-18T18:28:18.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-04-15T10:21:04.000Z (over 1 year ago)
Last Synced: 2024-06-27T15:35:48.138Z (4 months ago)
Topics: chatgpt, openai
Language: Svelte
Homepage: https://cheat-code.as93.net
Size: 254 KB
Stars: 37
Watchers: 2
Forks: 11
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        
💫 Cheat Code



  An AI-powered coding assistant, to generate, fix and improve code


  Built as a demo of OpenAI's GPT API


  cheat-code.as93.net





  

    

    


  

  ^{Yes, the UI is really ugly}



---

## Getting Started

### Developing

```bash

# 1. Clone the repo and cd into it (update username if you've forked)

git clone [email protected]:Lissy93/cheat-code.git && cd cheat-code

# 2. Install dependencies

pnpm install

# 3. Start the development server

pnpm run dev -- --open

```

### Manual Deploy

- Fork the repo, then follow the steps above to clone and install dependencies

- Add your `OPENAI_API_KEY` as an enviornmental variable (get a key [here](https://platform.openai.com/account/api-keys))

- Push changes to your repository

- Enable the build action, to deploy to a service of your choice

You can also build the site yourself `npm run build`, then either run `node build` to start the server, or use an appropriate [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.

### Quick Deploy

Use the 1-click deploy to get up and running in seconds.

[![Depoly Cheat Code to Netlify](https://img.shields.io/badge/Deploy-Netlify-%2330c8c9?style=for-the-badge&logo=netlify&labelColor=1e0e41 'Deploy Cheat Code to Netlify, via 1-Click Script')](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/cheat-code 'Deploy Cheat Code to Render, via 1-Click Script') [![Depoly Cheat Code to Render](https://img.shields.io/badge/Deploy-Render-%236c83fa?style=for-the-badge&logo=render&labelColor=1e0e41&logoColor=6c83fa)](https://render.com/deploy?repo=https://github.com/lissy93/cheat-code 'Deploy Cheat Code to Render, via 1-Click Script') [![Deploy Cheat Code to Railway](https://img.shields.io/badge/Deploy-Railway-%23853bce?style=for-the-badge&logo=railway&labelColor=1e0e41&logoColor=853bce)](https://railway.app/new/template/hROvhb 'Deploy Cheat Code to Railway, via 1-Click Script') [![Deploy Cheat Code to Vercel](https://img.shields.io/badge/Deploy-Vercel-%23ffffff?style=for-the-badge&logo=vercel&labelColor=1e0e41)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flissy93%2Fcheat-code&env=GITHUB_TOKEN,TWITTER_TOKEN&project-name=cheat-code&repository-name=cheat-code_My-Developer-Portfolio 'Deploy Cheat Code to Vercel, via 1-Click Script')

### Docker Deploy

There's a multi-arch [`Dockerfile`](https://github.com/Lissy93/cheat-code/blob/master/Dockerfile).

---

## Community

### Report an Issue

Found something that's not working? [Open an issue](https://github.com/Lissy93/cheat-code/issues/new/choose), and describe the problem, steps to reproduce alond with expected and actual output. If relevant, also include details about your environment. I'll try and fix / respond to any tickets within 48-hours.

### Contributing

Contributions of any kind are very welcome, and would be much appreciated.

For Code of Conduct, see [Contributor Convent](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).

To get started, fork the repo, make your changes, add, commit and push the code, then come back here to open a pull request. If you're new to GitHub or open source, [this guide](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3#let-s-make-our-first-pull-request-) or the [git docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) may help you get started, but feel free to reach out if you need any support.

[![Submit a PR](https://img.shields.io/badge/Submit_a_PR-GitHub-%23060606?style=for-the-badge&logo=github&logoColor=fff)](https://github.com/Lissy93/cheat-code/compare)

### Support

[![Sponsor Lissy93 on GitHub](https://img.shields.io/badge/Sponsor_on_GitHub-Lissy93-%23ff4dda?style=for-the-badge&logo=githubsponsors&logoColor=ff4dda)](https://github.com/sponsors/Lissy93)

---

## License

> _**[Lissy93/Cheat-Code](https://github.com/Lissy93/cheat-code)** is licensed under [MIT](https://gist.github.com/Lissy93/143d2ee01ccc5c052a17) © [Alicia Sykes](https://aliciasykes.com) 2022._
 > ^{For information, see TLDR Legal > MIT}

Expand License

```

The MIT License (MIT)

Copyright (c) Alicia Sykes 

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, sub-license, 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 install

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 MERCHANT ABILITY, FITNESS FOR A

PARTICULAR PURPOSE AND NON INFRINGEMENT. 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.

```

---



  © Alicia Sykes 2023


  Licensed under MIT


  


  ^{Thanks for visiting :)}