Skip to content

Commit 42a1fce

Browse files
Copilotlippytm
andcommitted
Add comprehensive Quick Start guide for easy onboarding
Co-authored-by: lippytm <[email protected]>
1 parent 91407e1 commit 42a1fce

File tree

1 file changed

+110
-0
lines changed

1 file changed

+110
-0
lines changed

QUICKSTART.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Quick Start Guide
2+
3+
This guide will help you get up and running with the AI-Time-Machines ChatGPT integration in just a few minutes.
4+
5+
## Step 1: Prerequisites
6+
7+
Ensure you have:
8+
- Node.js 18.0.0 or higher installed
9+
- npm (comes with Node.js)
10+
- An OpenAI account
11+
12+
## Step 2: Installation
13+
14+
Clone and set up the repository:
15+
16+
```bash
17+
git clone https://github.com/lippytm/AI-Time-Machines.git
18+
cd AI-Time-Machines
19+
npm install
20+
```
21+
22+
## Step 3: Get Your OpenAI API Key
23+
24+
1. Go to [https://platform.openai.com/](https://platform.openai.com/)
25+
2. Sign in or create an account
26+
3. Navigate to API Keys: [https://platform.openai.com/api-keys](https://platform.openai.com/api-keys)
27+
4. Click "Create new secret key"
28+
5. Copy the key (you won't see it again!)
29+
30+
## Step 4: Configure Your Environment
31+
32+
```bash
33+
# Copy the example environment file
34+
cp .env.example .env
35+
36+
# Edit .env and add your API key
37+
# OPENAI_API_KEY=sk-your-actual-key-here
38+
```
39+
40+
## Step 5: Test Your Setup
41+
42+
Run the examples to verify everything works:
43+
44+
```bash
45+
npm start
46+
```
47+
48+
You should see output from three different ChatGPT interactions!
49+
50+
## Step 6: Start Building
51+
52+
### Basic Usage
53+
54+
```javascript
55+
const { ChatGPT } = require('./src/index');
56+
57+
const chatgpt = new ChatGPT();
58+
const response = await chatgpt.chat('Hello, ChatGPT!');
59+
console.log(response);
60+
```
61+
62+
### Run More Examples
63+
64+
```bash
65+
node examples.js
66+
```
67+
68+
This runs 5 different examples showing various features.
69+
70+
## Common Issues
71+
72+
### Error: "OpenAI API key is required"
73+
74+
- Make sure your `.env` file exists in the project root
75+
- Check that `OPENAI_API_KEY` is set correctly in `.env`
76+
- Ensure there are no extra spaces or quotes around the key
77+
78+
### Error: "Module not found"
79+
80+
Run `npm install` to install all dependencies.
81+
82+
### Rate Limit Errors
83+
84+
- Free tier has rate limits
85+
- Consider upgrading your OpenAI plan
86+
- Add delays between requests if needed
87+
88+
## Next Steps
89+
90+
- Read the full [README.md](README.md) for detailed documentation
91+
- Review [examples.js](examples.js) for usage patterns
92+
- Check out the [OpenAI API docs](https://platform.openai.com/docs) for advanced features
93+
94+
## Security Reminders
95+
96+
⚠️ **Never commit your `.env` file to version control!**
97+
98+
- `.env` is already in `.gitignore`
99+
- Use `.env.example` as a template
100+
- Keep your API key secure
101+
- Rotate keys if they're exposed
102+
103+
## Getting Help
104+
105+
- [GitHub Issues](https://github.com/lippytm/AI-Time-Machines/issues)
106+
- [GitHub Discussions](https://github.com/lippytm/AI-Time-Machines/discussions)
107+
- [OpenAI Community Forum](https://community.openai.com/)
108+
- [OpenAI API Documentation](https://platform.openai.com/docs)
109+
110+
Happy coding! 🚀

0 commit comments

Comments
 (0)