aoutler/aidgaf-server
aoutler/aidgaf-server
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Not for use in California

Browse Source
This commit is contained in:
Adam Outler 2024-09-24 13:57:17 +00:00
parent a4c63a7177
commit 127892b5f2
1 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
README.md
View File

@ -1,49 +1,49 @@
# How Much Do You Not Give a F***? # How Much Do You Not Give a F***?
A fun application that connects to OpenAI APIs to determine just how much you don't give a f***! A fun application that connects to OpenAI APIs to determine just how much you don't give a f***!
## Getting Started ## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
## Prerequisites ## Prerequisites
* Docker * Docker
* An OpenAI API key, obtained from the OpenAI website. * An OpenAI API key, obtained from the OpenAI website.
## Installing ## Installing
1. Clone the repository to your local machine: 1. Clone the repository to your local machine:
``` bash ``` bash
git clone https://git.adamoutler.com/aoutler/aidgaf-server git clone https://git.adamoutler.com/aoutler/aidgaf-server
``` ```
2. Open the project in Visual Studio Code. 2. Open the project in Visual Studio Code.
3. Follow the prompts to open the Devcontainer and begin developing. 3. Follow the prompts to open the Devcontainer and begin developing.
## Development ## Development
1. Set the APIKEY environment variable by using the Secrets extension in Visual Studio Code. 1. Set the APIKEY environment variable by using the Secrets extension in Visual Studio Code.
2. Press F5 in Visual Studio Code to start the server. 2. Press F5 in Visual Studio Code to start the server.
## Usage ## Usage
The server accepts a message in the following format: The server accepts a message in the following format:
``` json ``` json
{"message":{"command":"aidgaf","data":{"username":"AdamOutler"},"timestamp":1676231329}} {"message":{"command":"aidgaf","data":{"username":"AdamOutler"},"timestamp":1676231329}}
``` ```
## Built With ## Built With
* [Docker](https://www.docker.com/) * [Docker](https://www.docker.com/)
* [Visual Studio Code](https://code.visualstudio.com/) * [Visual Studio Code](https://code.visualstudio.com/)
* [OpenAI](https://openai.com/) * [OpenAI](https://openai.com/)
* [Python](https://www.python.org/) * [Python](https://www.python.org/)
* [Automated builds by Jenkins](https://jenkins.adamoutler.com/blue/organizations/jenkins/Update%20IDGAF%20Server/activity) * [Automated builds by Jenkins](https://jenkins.adamoutler.com/blue/organizations/jenkins/Update%20IDGAF%20Server/activity)
## Contributing ## Contributing
If you would like to contribute to this project, please fork the repository and submit a pull request. If you would like to contribute to this project, please fork the repository and submit a pull request.
## License ## License
Copyright 2023 Adam Outler Copyright 2023 Adam Outler
Licensed under the I Dont Give A F License, Version 1.0 (the "License"); Licensed under the I Dont Give A F License, Version 1.1 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
0. Not for use in California.
3. Send an email to idgaf@hackedyour.info if you find this helpful. 3. Send an email to idgaf@hackedyour.info if you find this helpful.
Note: If you're wondering where number 1 and 2 are, IDGAF. Note: If you're wondering where numbers 1 and 2 are, IDGAF.
## Acknowledgments ## Acknowledgments
* This README was generated using OpenAI's language model, ChatGPT. * This README was generated using OpenAI's language model, ChatGPT.
* The Python code in other areas was documented using Github Copilot. * The Python code in other areas was documented using Github Copilot.
* AI is used for documentation because the author didn't give a f*** enough to write it himself. * AI is used for documentation because the author didn't give a f*** enough to write it himself.