Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clairefro/sos-client
a functional parody of Stack Overflow, using AI
https://github.com/clairefro/sos-client
Last synced: 2 months ago
JSON representation
a functional parody of Stack Overflow, using AI
- Host: GitHub
- URL: https://github.com/clairefro/sos-client
- Owner: clairefro
- License: other
- Created: 2024-05-11T17:31:31.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-05T14:39:52.000Z (2 months ago)
- Last Synced: 2024-11-05T15:42:20.619Z (2 months ago)
- Language: JavaScript
- Homepage: https://sosimulator.xyz
- Size: 356 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StackOverflow Simulator - Client
A functional parody of Stack Overflow, using AI to generate instant replies to coding questions.
[demo](https://github.com/user-attachments/assets/97b18e8c-d5bc-4c2b-b9b3-43bea328935e)
This is the client app, which relies on the [Stack Overflow Simulator API](https://github.com/clairefro/sos-api)
## Rate limit
Currently limits to 15 calls/min
## Devlopment and running locally
You can run Stack Overflow Simulator locally using your own OpenAI API key for greater control of your data.
You will need your own [OpenAI API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key)
### 1. Set up the sos-api
Clone and run the [Stack Overflow Simulator API](https://github.com/clairefro/sos-api?tab=readme-ov-file#devlopment-and-running-locally)
```sh
git clone [email protected]:clairefro/sos-api.git
# navigate to the project directory
cd sos-api
# set up environment
cp .env.example .env
# paste your OpenAI API key as the value for OPENAI_API_KEY in .env, save
npm install
npm run dev
```
The above steps will run the API on port 3000
### 2. Set up the sos-client
Somewhere else, clone this client repo
```sh
git clone [email protected]:clairefro/sos-client.git
# navigate to the project directory
cd sos-client
# set up environment
cp .env.example .env
npm install
npm run dev
```
This should launch the client app on port `:5173` by default. If the browser doesn't launch automaticcally, navigate to `http://localhost:5173`
The app will look for the API running on port `:3000`
Happy debugging!