Skip to content

clairefro/sos-client

Repository files navigation

StackOverflow Simulator - Client

A functional parody of Stack Overflow, using AI to generate instant replies to coding questions.

demo.webm

This is the client app, which relies on the Stack Overflow Simulator API

mermaid-diagram-2024-08-26-115855

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

1. Set up the sos-api

Clone and run the Stack Overflow Simulator API

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

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!

About

a functional parody of Stack Overflow, using AI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published