https://github.com/clairefro/sos-api

https://github.com/clairefro/sos-api

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/clairefro/sos-api
• Owner: clairefro
• License: other
• Created: 2024-05-11T15:53:43.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-05T15:22:28.000Z (4 months ago)
• Last Synced: 2024-09-05T23:11:38.768Z (4 months ago)
• Language: TypeScript
• Size: 141 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# StackOverflow Simulator - API

Relive the good ol' days of SO, with all the nostalgic sass.

This is the API used by the [Stack Overflow Simulator client app](https://github.com/clairefro/sos-client)

## Devlopment and running locally

`cp .env.example .env` <-- add required env vars, such as `OPENAI_API_KEY`

`npm install`

`npm run dev`

This will run the API on port :3000 by default

If you'd like to use the API, either

1. Import the Postman Collection in the project root

2. Clone and launch the [SOS client app](https://github.com/clairefro/sos-client)

## Build

`npm run build`

## Note to self

Prod hosted on Render