-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Docs/add full repository documentation #1674
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
billlzzz10
wants to merge
6
commits into
dyad-sh:main
from
billlzzz10:docs/add-full-repository-documentation
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e933271
docs: Add comprehensive documentation across the repository
google-labs-jules[bot] dde4ddf
Merge branch 'main' into docs/add-full-repository-documentation
billlzzz10 6533194
Update README.md
billlzzz10 b212a02
Update CONTRIBUTING.th.md
billlzzz10 35da2a4
Update CONTRIBUTING.th.md
billlzzz10 4fa367e
Merge branch 'main' into docs/add-full-repository-documentation
billlzzz10 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| # การมีส่วนร่วม | ||
|
|
||
| Dyad ยังเป็นโปรเจกต์ในระยะเริ่มต้นมากๆ ดังนั้นโค้ดเบสจึงมีการเปลี่ยนแปลงอย่างรวดเร็ว | ||
|
|
||
| ก่อนที่จะเปิด Pull Request กรุณาเปิด Issue เพื่อหารือกันก่อนว่าการเปลี่ยนแปลงนั้นเหมาะสมกับ Dyad หรือไม่ การรักษาประสบการณ์การใช้งานที่สอดคล้องกันบางครั้งหมายความว่าเราไม่สามารถรวมทุกฟีเจอร์ที่เป็นไปได้ หรือเราต้องพิจารณาการออกแบบในระยะยาวว่าเราต้องการสนับสนุนฟีเจอร์ในด้านนั้นๆ อย่างไร | ||
|
|
||
| สำหรับภาพรวมระดับสูงเกี่ยวกับวิธีการทำงานของ Dyad โปรดดูที่ [คู่มือสถาปัตยกรรม](./docs/architecture.th.md) การทำความเข้าใจสถาปัตยกรรมจะช่วยให้แน่ใจว่าการมีส่วนร่วมของคุณสอดคล้องกับการออกแบบโดยรวมของโปรเจกต์ | ||
|
|
||
| ## การมีส่วนร่วมที่ไม่ใช่แค่โค้ด | ||
|
|
||
| สิ่งที่ผมรู้สึกขอบคุณมากๆ คือการมีส่วนร่วมที่ไม่ใช่โค้ด เช่น การรายงานบั๊ก, การเขียนคำขอฟีเจอร์ และการมีส่วนร่วมใน [sub-reddit ของ Dyad](https://www.reddit.com/r/dyadbuilders) | ||
|
|
||
| ## การพัฒนา | ||
|
|
||
| Dyad เป็นแอปพลิเคชัน Electron | ||
|
|
||
| **ติดตั้ง Dependencies:** | ||
|
|
||
| ```sh | ||
| npm install | ||
| ``` | ||
|
|
||
| **สร้างไดเรกทอรี userData (จำเป็นสำหรับฐานข้อมูล)** | ||
|
|
||
| ```sh | ||
| # Unix/macOS/Linux: | ||
| mkdir -p userData | ||
|
|
||
| # Windows PowerShell (รันเมื่อโฟลเดอร์ยังไม่มี): | ||
| mkdir userData | ||
|
|
||
| # Windows Command Prompt (รันเมื่อโฟลเดอร์ยังไม่มี): | ||
| md userData | ||
| ``` | ||
|
|
||
| **ใช้ Migrations:** | ||
|
|
||
| ```sh | ||
| # สร้างและใช้ database migrations | ||
| npm run db:generate | ||
| npm run db:push | ||
| ``` | ||
|
|
||
| **รันบนเครื่อง:** | ||
|
|
||
| ```sh | ||
| npm start | ||
| ``` | ||
|
|
||
| ## การตั้งค่า | ||
|
|
||
| หากคุณต้องการส่ง Pull Request เราขอแนะนำอย่างยิ่งให้ตั้งค่า pre-commit hooks ซึ่งจะทำการฟอร์แมตและตรวจสอบโค้ดก่อนการ commit ทุกครั้ง นี่เป็นวิธีที่ยอดเยี่ยมในการตรวจจับปัญหาตั้งแต่เนิ่นๆ โดยไม่ต้องรอให้ GitHub Actions ทำงานสำหรับ Pull Request ของคุณ | ||
|
|
||
| เพียงแค่รันคำสั่งนี้ครั้งเดียวใน repo ของคุณ: | ||
|
|
||
| ```sh | ||
| npm run init-precommit | ||
| ``` | ||
|
|
||
| ## การทดสอบ | ||
|
|
||
| ### Unit tests | ||
|
|
||
| ```sh | ||
| npm test | ||
| ``` | ||
|
|
||
| ### E2E tests | ||
|
|
||
| บิวด์แอปสำหรับการทดสอบ E2E: | ||
|
|
||
| ```sh | ||
| npm run pre:e2e | ||
| ``` | ||
|
|
||
| > หมายเหตุ: คุณจะต้องบิวด์แอปใหม่เมื่อมีการเปลี่ยนแปลงโค้ดของแอปเท่านั้น ไม่จำเป็นต้องบิวด์ใหม่หากคุณแค่แก้ไขไฟล์ทดสอบ | ||
|
|
||
| รันชุดการทดสอบ E2E ทั้งหมด: | ||
|
|
||
| ```sh | ||
| npm run e2e | ||
| ``` | ||
|
|
||
| รันไฟล์ทดสอบที่ต้องการ: | ||
|
|
||
| ```sh | ||
| npm run e2e e2e-tests/context_manage.spec.ts | ||
| ``` | ||
|
|
||
| อัปเดต snapshots สำหรับการทดสอบ: | ||
|
|
||
| ```sh | ||
| npm run e2e e2e-tests/context_manage.spec.ts -- --update-snapshots | ||
| npm run e2e e2e-tests/context_manage.spec.ts -- --update-snapshots |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -22,6 +22,35 @@ No sign-up required. Just download and go. | |||||
|
|
||||||
| Join our growing community of AI app builders on **Reddit**: [r/dyadbuilders](https://www.reddit.com/r/dyadbuilders/) - share your projects and get help from the community! | ||||||
|
|
||||||
| ## Setup | ||||||
|
|
||||||
| To set up the development environment, follow these steps: | ||||||
|
|
||||||
| 1. **Clone the repository**: | ||||||
| ```bash | ||||||
| git clone | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The cloned command in the setup instructions omits the repository URL, so developers cannot follow the documented setup steps. Prompt for AI agents
Suggested change
|
||||||
| cd dyad | ||||||
| ``` | ||||||
|
|
||||||
| 2. **Install dependencies**: | ||||||
| This project uses `npm`. To install the dependencies, run: | ||||||
| ```bash | ||||||
| npm install | ||||||
| ``` | ||||||
|
|
||||||
| 3. **Set up environment variables**: | ||||||
| Copy the `.env.example` file to `.env`. You will need to add the necessary API keys and configurations to this file. | ||||||
|
|
||||||
| ## Usage | ||||||
|
|
||||||
| To start the development server, run the following command: | ||||||
|
|
||||||
| ```bash | ||||||
| npm start | ||||||
| ``` | ||||||
|
|
||||||
| This will start the application in development mode, with hot-reloading enabled. | ||||||
|
|
||||||
| ## 🛠️ Contributing | ||||||
|
|
||||||
| **Dyad** is open-source (Apache 2.0 licensed). | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Dyad (ไดแอด) | ||
|
|
||
| Dyad คือเครื่องมือสร้างแอปพลิเคชัน AI แบบโอเพนซอร์สที่ทำงานบนเครื่องของคุณโดยตรง รวดเร็ว เป็นส่วนตัว และอยู่ภายใต้การควบคุมของคุณอย่างเต็มรูปแบบ — เหมือนกับ Lovable, v0, หรือ Bolt แต่ทำงานบนเครื่องของคุณเอง | ||
|
|
||
| [](http://dyad.sh/) | ||
|
|
||
| ข้อมูลเพิ่มเติมที่: [http://dyad.sh/](http://dyad.sh/) | ||
|
|
||
| ## 🚀 ฟีเจอร์เด่น | ||
|
|
||
| - ⚡️ **ทำงานบนเครื่อง (Local)**: รวดเร็ว เป็นส่วนตัว และไม่มีการผูกมัด | ||
| - 🛠 **ใช้คีย์ API ของคุณเอง**: ใช้คีย์ API ของคุณเองได้เลย — ไม่มีการผูกมัดกับผู้ให้บริการรายใด | ||
| - 🖥️ **ทำงานข้ามแพลตฟอร์ม**: ใช้งานง่ายบน Mac หรือ Windows | ||
|
|
||
| ## 📦 ดาวน์โหลด | ||
|
|
||
| ไม่ต้องสมัครสมาชิก เพียงดาวน์โหลดและใช้งานได้ทันที | ||
|
|
||
| ### [👉 ดาวน์โหลดสำหรับแพลตฟอร์มของคุณ](https://www.dyad.sh/#download) | ||
|
|
||
| ## 🤝 ชุมชน | ||
|
|
||
| เข้าร่วมชุมชนนักสร้างแอป AI ที่กำลังเติบโตของเราบน **Reddit**: [r/dyadbuilders](https://www.reddit.com/r/dyadbuilders/) - แบ่งปันโปรเจกต์ของคุณและรับความช่วยเหลือจากชุมชน! | ||
|
|
||
| ## การติดตั้ง | ||
|
|
||
| ทำตามขั้นตอนต่อไปนี้เพื่อตั้งค่าสภาพแวดล้อมการพัฒนา: | ||
|
|
||
| 1. **โคลนโปรเจกต์**: | ||
| ```bash | ||
| git clone https://github.com/your-repo/dyad.git | ||
| cd dyad | ||
| ``` | ||
|
|
||
| 2. **ติดตั้ง Dependencies**: | ||
| โปรเจกต์นี้ใช้ `npm` ในการจัดการ dependencies ติดตั้งโดยใช้คำสั่ง: | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 3. **ตั้งค่า Environment Variables**: | ||
| คัดลอกไฟล์ `.env.example` ไปยัง `.env` และเพิ่ม API keys และการตั้งค่าที่จำเป็นลงในไฟล์นี้ | ||
|
|
||
| ## การใช้งาน | ||
|
|
||
| ในการเริ่มเซิร์ฟเวอร์สำหรับพัฒนา ให้รันคำสั่งต่อไปนี้: | ||
|
|
||
| ```bash | ||
| npm start | ||
| ``` | ||
|
|
||
| คำสั่งนี้จะเริ่มแอปพลิเคชันในโหมดพัฒนา พร้อมกับการรีโหลดอัตโนมัติเมื่อมีการเปลี่ยนแปลงโค้ด | ||
|
|
||
| ## 🛠️ การมีส่วนร่วม | ||
|
|
||
| **Dyad** เป็นโปรเจกต์โอเพนซอร์ส (ภายใต้ลิขสิทธิ์ Apache 2.0) | ||
|
|
||
| หากคุณสนใจที่จะมีส่วนร่วมกับ Dyad โปรดอ่านเอกสาร [การมีส่วนร่วม](./CONTRIBUTING.md) ของเรา |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cloned command in the setup instructions omits the repository URL, so developers cannot follow the documented setup steps.
Prompt for AI agents