tinazone commited on
Commit
00009f8
·
verified ·
1 Parent(s): 21d7fc3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -57
README.md CHANGED
@@ -1,3 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # Word to Code
2
 
3
  [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/tinazone/word-to-code)
@@ -30,16 +43,6 @@ Note: When pushing, use a HuggingFace access token with write permissions as you
30
 
31
  ## 🎨 Space Configuration
32
 
33
- ---
34
- title: Word to Code - Visual Code Sketch Generator
35
- emoji: 🎨
36
- colorFrom: blue
37
- colorTo: purple
38
- sdk: docker
39
- pinned: false
40
- app_port: 3000
41
- ---
42
-
43
  ## Local Development
44
 
45
  1. Create a `.env.local` file in the root directory:
@@ -50,50 +53,4 @@ GEMINI_API_KEY=your_api_key_here
50
  2. Install dependencies:
51
  ```bash
52
  npm install
53
- ```
54
-
55
- 3. Run the development server:
56
- ```bash
57
- npm run dev
58
- ```
59
-
60
- Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
61
-
62
- ## Features
63
-
64
- - Transform natural language descriptions into visual code sketches
65
- - Download sketches as GIF animations
66
- - Real-time code generation and visualization
67
- - Modern, responsive UI
68
-
69
- ## Technical Stack
70
-
71
- - Next.js 14
72
- - React 18
73
- - Tailwind CSS
74
- - P5.js for sketching
75
- - FFmpeg for GIF generation
76
- - Gemini 2.0 for code generation
77
-
78
- You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
79
-
80
- [API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
81
-
82
- The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) instead of React pages.
83
-
84
- This project uses [`next/font`](https://nextjs.org/docs/pages/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
85
-
86
- ## Learn More
87
-
88
- To learn more about Next.js, take a look at the following resources:
89
-
90
- - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
91
- - [Learn Next.js](https://nextjs.org/learn-pages-router) - an interactive Next.js tutorial.
92
-
93
- You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
94
-
95
- ## Deploy on Vercel
96
-
97
- The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
98
-
99
- Check out our [Next.js deployment documentation](https://nextjs.org/docs/pages/building-your-application/deploying) for more details.
 
1
+ ---
2
+ title: Word to Code - Visual Code Sketch Generator
3
+ emoji: 🎨
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: docker
7
+ sdk_version: 3.0.0
8
+ app_port: 3000
9
+ pinned: false
10
+ ---
11
+
12
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
13
+
14
  # Word to Code
15
 
16
  [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/tinazone/word-to-code)
 
43
 
44
  ## 🎨 Space Configuration
45
 
 
 
 
 
 
 
 
 
 
 
46
  ## Local Development
47
 
48
  1. Create a `.env.local` file in the root directory:
 
53
  2. Install dependencies:
54
  ```bash
55
  npm install
56
+ ```