@@ -117,6 +117,122 @@ No sign-up. No cloud lock-in. Just download and build.
117117
118118---
119119
120+ ## 🛠️ Development Setup
121+
122+ ### Prerequisites
123+
124+ - ** Node.js** (>=20)
125+ - ** npm** or ** pnpm** (recommended)
126+
127+ ### Installation
128+
129+ 1 . ** Clone the repository:**
130+
131+ ``` sh
132+ git clone https://github.com/SFARPak/AliFullStack.git
133+ cd AliFullStack
134+ ```
135+
136+ 2 . ** Install dependencies:**
137+
138+ ``` sh
139+ npm install
140+ # or
141+ pnpm install
142+ ```
143+
144+ 3 . ** Create the userData directory (required for database):**
145+
146+ ``` sh
147+ # Unix/macOS/Linux:
148+ mkdir -p userData
149+
150+ # Windows PowerShell:
151+ mkdir userData
152+
153+ # Windows Command Prompt:
154+ md userData
155+ ```
156+
157+ 4 . ** Apply database migrations:**
158+
159+ ``` sh
160+ npm run db:generate
161+ npm run db:push
162+ ```
163+
164+ 5 . ** Run in development mode:**
165+
166+ ``` sh
167+ npm start
168+ ```
169+
170+ This will start the Electron app in development mode.
171+
172+ ### Optional Setup
173+
174+ - ** Set up pre-commit hooks** (recommended for contributors):
175+
176+ ``` sh
177+ npm run init-precommit
178+ ```
179+
180+ - ** Database management:**
181+
182+ ``` sh
183+ # Open Drizzle Studio for database inspection
184+ npm run db:studio
185+ ```
186+
187+ ### Testing
188+
189+ - ** Run unit tests:**
190+
191+ ``` sh
192+ npm test
193+ ```
194+
195+ - ** Run E2E tests:**
196+
197+ First, build the app for testing:
198+
199+ ``` sh
200+ npm run pre:e2e
201+ ```
202+
203+ Then run the tests:
204+
205+ ``` sh
206+ npm run e2e
207+ ```
208+
209+ ### Pushing Changes to GitHub
210+
211+ 1 . ** Create a feature branch:**
212+
213+ ``` sh
214+ git checkout -b your-feature-branch
215+ ```
216+
217+ 2 . ** Make your changes and commit:**
218+
219+ ``` sh
220+ git add .
221+ git commit -m " Your commit message"
222+ ```
223+
224+ 3 . ** Push to your fork:**
225+
226+ ``` sh
227+ git push origin your-feature-branch
228+ ```
229+
230+ 4 . ** Create a Pull Request** on GitHub from your feature branch to the main branch.
231+
232+ For more details, see ** [ CONTRIBUTING.md] ( ./CONTRIBUTING.md ) ** .
233+
234+ ---
235+
120236## 👥 Join the Community
121237
122238Be part of a growing network of ** AI tinkerers** , ** indie hackers** , and ** full-stack dreamers** :
0 commit comments