ydev-mern 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,76 @@
1
+ # ydev-mern
2
+
3
+ A modern, production-ready full-stack MERN (MongoDB, Express, React, Node.js) development kit featuring a sleek Vite + React frontend and an Express backend.
4
+
5
+ ## Quick Start
6
+
7
+ ### 1. Install via npm
8
+ You can install `ydev-mern` directly into your project:
9
+
10
+ ```bash
11
+ npm i ydev-mern
12
+ ```
13
+
14
+ This installs both the `frontend` and `backend` directories into your `node_modules/ydev-mern/`.
15
+
16
+ ---
17
+
18
+ ### 2. Scaffold into your project (Recommended)
19
+ To unpack both `frontend` and `backend` directly into your project folder:
20
+
21
+ ```bash
22
+ npx ydev-mern
23
+ ```
24
+
25
+ Or into a new folder:
26
+ ```bash
27
+ npx ydev-mern my-mern-app
28
+ cd my-mern-app
29
+ ```
30
+
31
+ ---
32
+
33
+ ## Project Structure
34
+
35
+ ```text
36
+ my-mern-app/
37
+ ├── backend/
38
+ │ ├── src/
39
+ │ │ ├── Server.js # Express server entry
40
+ │ │ └── db.js # MongoDB connection utility
41
+ │ ├── .env.example # Environment variables template
42
+ │ └── package.json
43
+ └── frontend/
44
+ ├── src/
45
+ │ ├── App.jsx # Modern React showcase & UI
46
+ │ ├── App.css
47
+ │ └── main.jsx
48
+ ├── index.html
49
+ ├── vite.config.js
50
+ └── package.json
51
+ ```
52
+
53
+ ---
54
+
55
+ ## Running the Application
56
+
57
+ ### Backend
58
+ ```bash
59
+ cd backend
60
+ npm install
61
+ npm run dev
62
+ ```
63
+ Runs Express on `http://localhost:3000`.
64
+
65
+ ### Frontend
66
+ ```bash
67
+ cd frontend
68
+ npm install
69
+ npm run dev
70
+ ```
71
+ Runs Vite dev server on `http://localhost:5173`.
72
+
73
+ ---
74
+
75
+ ## License
76
+ MIT © [yakshith.v](https://github.com/YAKSHITH-1)
@@ -0,0 +1 @@
1
+ MONGO_URI=