OpenAI TypeScript Starter by Joseph Writes Code

The hardest part of learning something new is often just getting started. This starter project is designed to get you up and running with a minimal OpenAI TypeScript project as quickly as possible, so you can focus on learning new things. It includes comments in most files to help you understand what's going on, in terms of configuration.

Who is this for?

• Beginners who want to learn without getting bogged down in configuration.
• Experienced developers who want to start a new project quickly.
• And folks who are here from one of my tutorials. 😃

What's Included

• Next-gen TypeScript configured for ES Modules
• OpenAI API with OpenAI-Node
• API Key Loading with dotenv
• Linting with ESLint
• Formatting with Prettier
• Bundling with Pkgroll
• Dev watch mode with tsx
• Web server with Fastify

Installation

Create repo from template

1. Click the Use this template button above the file list
2. Select Create a new repository

Manually copy and paste

1. Clone this repository
2. Copy the contents of the repository to your project directory
3. Run npm install to install dependencies

Development

1. Run npm run dev to start watch mode
2. Edit src/index.mts and watch the changes live in your browser

Building

1. Run npm run build to build your project
2. Run npm run start to run your project

License

The project starter is available as open source under the terms of the MIT License.