UNPKG

@tmraaex/create-structure

Version:

CLI-verktyg för att skapa en standardiserad projektstruktur med TypeScript

58 lines (42 loc) • 1.55 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# My Express Project 🚀 This is a Node.js + Express project using TypeScript, following best practices for structure and maintainability. ## 📂 Project Structure /src /models # Database models /controllers # Route logic /routes # API routes /middlewares # Custom middlewares /config # Configuration files /utils # Utility functions /services # Business logic /interfaces # TypeScript interfaces index.ts # Entry point for the Express server tsconfig.json # TypeScript configuration package.json # Dependencies & scripts .gitignore # Git ignored files .env # Envirnment virables README.md # Project documentation ## 🚀 Getting Started navigate to the correct folder ```sh cd /<projectname> ``` ### 1️⃣ Install dependencies ```sh npm install ``` 2️⃣ Start the development server ```sh npm run dev ``` The server will start, and you should see output indicating it's running. ## 🛠 Available Scripts npm run dev - Starts the development server with live reload npm run build - Compiles TypeScript files to JavaScript ⚠️ Note: The build setup is not yet complete, so the server can currently only run in development mode. Use npm run dev to start the server. Production support will be added in a future update. npm start - Runs the compiled JavaScript server ## 📌 Notes Make sure you have Node.js and npm installed. Change the variables in .env to fit your needs Adjust configurations in /config/ as needed. TypeScript will automatically check for type errors.