Skip to content

Commit 0620afd

Browse files
docs: update contributing guide for per-app npm usage
1 parent 8f7e1ea commit 0620afd

File tree

1 file changed

+36
-18
lines changed

1 file changed

+36
-18
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -132,24 +132,42 @@ Style guide
132132
- backend : `./apps/linkstash-backend/.env`
133133
- nextjs supports having environment specific env file e.g `env.local` for local development.
134134
- frontend : `./apps/linkstash-frontened/.env`
135-
- Backend:
136-
- Run migrations:
137-
```bash
138-
npm -w=apps/linkstash-backend run migrate
139-
```
140-
- Start the backend:
141-
```bash
142-
npm -w=apps/linkstash-backend run dev
143-
```
144-
- Alternatively, run the backend without debugging for slightly faster startup time:
145-
```bash
146-
npm -w=apps/linkstash-backend start
147-
```
148-
- Frontend:
149-
- Start the frontend:
150-
```bash
151-
npm -w=apps/linkstash-frontend run dev
152-
```
135+
- Each application (backend and frontend) is an independent npm project, so run npm commands from within the respective dire
136+
ctory.
137+
3. **Start the backend**
138+
1. Change into the backend project from the repository root:
139+
```bash
140+
cd apps/linkstash-backend
141+
```
142+
2. Install dependencies:
143+
```bash
144+
npm install
145+
```
146+
3. Initialize the database schema:
147+
```bash
148+
npm run migrate
149+
```
150+
4. Start the backend in watch mode:
151+
```bash
152+
npm run dev
153+
```
154+
5. Alternatively, run the backend without debugging for slightly faster startup time:
155+
```bash
156+
npm start
157+
```
158+
4. **Start the frontend**
159+
1. Change into the frontend project from the repository root:
160+
```bash
161+
cd apps/linkstash-frontend
162+
```
163+
2. Install dependencies:
164+
```bash
165+
npm install
166+
```
167+
3. Start the frontend:
168+
```bash
169+
npm run dev
170+
```
153171

154172
## Community Standards
155173
- Don’t be a dick.

0 commit comments

Comments
 (0)