💫 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

# 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)
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 for your target environment.

Quick Deploy

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

Docker Deploy

There's a multi-arch Dockerfile.

Community

Report an Issue

Found something that's not working? Open an issue, 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.

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 or the git docs may help you get started, but feel free to reach out if you need any support.

Support

License

Lissy93/Cheat-Code is licensed under MIT © Alicia Sykes 2022.
> ^{For information, see TLDR Legal > MIT}

Expand License

The MIT License (MIT)
Copyright (c) Alicia Sykes <[email protected]>

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.

AS93