Update README.md
Browse files
README.md
CHANGED
@@ -5,30 +5,83 @@ sdk: docker
|
|
5 |
emoji: π
|
6 |
colorFrom: purple
|
7 |
colorTo: blue
|
8 |
-
short_description: 'Transform your ideas into complete websites instantly.
|
9 |
---
|
10 |
|
11 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
12 |
|
13 |
-
|
14 |
-
|
15 |
-
Generate small apps with one prompt. Powered by the Gemini API.
|
16 |
-
</p>
|
17 |
|
18 |
-
Try it
|
19 |
|
20 |
-
This project is
|
21 |
|
22 |
-
## Tech
|
23 |
-
- [Gemini API](https://ai.google.dev/gemini-api/docs)
|
24 |
-
- [Sandpack](https://sandpack.codesandbox.io/) for
|
25 |
-
- Next.js app router with Tailwind
|
26 |
|
27 |
You can also experiment with Gemini in [Google AI Studio](https://aistudio.google.com/).
|
28 |
|
29 |
-
## Cloning &
|
30 |
-
1. Clone the repo: `git clone https://github.com/
|
31 |
2. Create a `.env` file and add your [Google AI Studio API key](https://aistudio.google.com/app/apikey): `GOOGLE_AI_API_KEY=`
|
32 |
3. Run `npm install` and `npm run dev` to install dependencies and run locally
|
33 |
|
34 |
-
**This is a personal project and not a Google official project**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
5 |
emoji: π
|
6 |
colorFrom: purple
|
7 |
colorTo: blue
|
8 |
+
short_description: 'Transform your ideas into complete websites instantly.'
|
9 |
---
|
10 |
|
11 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
12 |
|
13 |
+
# Prompta
|
14 |
+
Transform your ideas into complete websites instantly. Powered by AI.
|
|
|
|
|
15 |
|
16 |
+
Try it at: https://huggingface.co/spaces/[YOUR_USERNAME]/Prompta
|
17 |
|
18 |
+
This project is inspired by [llamacoder](https://github.com/Nutlope/llamacoder). Please follow [Nutlope](https://github.com/Nutlope) and give them a star.
|
19 |
|
20 |
+
## Tech Stack
|
21 |
+
- [Gemini API](https://ai.google.dev/gemini-api/docs) for AI generation
|
22 |
+
- [Sandpack](https://sandpack.codesandbox.io/) for code sandbox
|
23 |
+
- Next.js app router with Tailwind CSS
|
24 |
|
25 |
You can also experiment with Gemini in [Google AI Studio](https://aistudio.google.com/).
|
26 |
|
27 |
+
## Cloning & Running Locally
|
28 |
+
1. Clone the repo: `git clone https://github.com/[YOUR_USERNAME]/Prompta`
|
29 |
2. Create a `.env` file and add your [Google AI Studio API key](https://aistudio.google.com/app/apikey): `GOOGLE_AI_API_KEY=`
|
30 |
3. Run `npm install` and `npm run dev` to install dependencies and run locally
|
31 |
|
32 |
+
**This is a personal project and not a Google official project**
|
33 |
+
|
34 |
+
---
|
35 |
+
|
36 |
+
### Troubleshooting Build Issues
|
37 |
+
If your Hugging Face Space isn't building properly:
|
38 |
+
|
39 |
+
1. **Dockerfile Requirements**:
|
40 |
+
- Ensure you have a `Dockerfile` in your root directory
|
41 |
+
- Example Dockerfile:
|
42 |
+
```dockerfile
|
43 |
+
FROM node:18-alpine
|
44 |
+
WORKDIR /app
|
45 |
+
COPY package*.json ./
|
46 |
+
RUN npm install
|
47 |
+
COPY . .
|
48 |
+
RUN npm run build
|
49 |
+
EXPOSE 7860
|
50 |
+
CMD ["npm", "start"]
|
51 |
+
```
|
52 |
+
|
53 |
+
2. **Port Configuration**:
|
54 |
+
- Hugging Face Spaces requires port 7860
|
55 |
+
- In your Next.js app, add to `next.config.js`:
|
56 |
+
```js
|
57 |
+
/** @type {import('next').NextConfig} */
|
58 |
+
const nextConfig = {
|
59 |
+
output: 'standalone',
|
60 |
+
images: {
|
61 |
+
unoptimized: true
|
62 |
+
}
|
63 |
+
}
|
64 |
+
module.exports = nextConfig
|
65 |
+
```
|
66 |
+
|
67 |
+
3. **Environment Variables**:
|
68 |
+
- Add `GOOGLE_AI_API_KEY` as a secret in your Space settings
|
69 |
+
- Don't commit `.env` files to your repository
|
70 |
+
|
71 |
+
4. **Build Command**:
|
72 |
+
- Ensure your `package.json` has:
|
73 |
+
```json
|
74 |
+
{
|
75 |
+
"scripts": {
|
76 |
+
"dev": "next dev",
|
77 |
+
"build": "next build",
|
78 |
+
"start": "next start"
|
79 |
+
}
|
80 |
+
}
|
81 |
+
```
|
82 |
+
|
83 |
+
5. **Common Issues**:
|
84 |
+
- Missing dependencies: Check all packages are in `package.json`
|
85 |
+
- Build timeouts: Optimize build process or increase Space resources
|
86 |
+
- Port conflicts: Ensure nothing else uses port 7860
|
87 |
+
- File paths: Verify all paths in Dockerfile are correct
|