You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: backend/Readme.md
+24-7Lines changed: 24 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,9 @@
1
1
# 📂 File Manager Backend
2
2
3
-
This backend provides a RESTful API for managing files and folders, intended to be used with a front-end file manager component. It allows users to perform various operations such as creating folders, uploading files, renaming, moving, copying, deleting, and downloading files. All APIs are documented using **Swagger**.
3
+
This backend provides a RESTful API for managing files and folders, intended to be used with a
4
+
front-end file manager component. It allows users to perform various operations such as creating
5
+
folders, uploading files, renaming, moving, copying, deleting, and downloading files. All APIs are
6
+
documented using **Swagger**.
4
7
5
8
## 🚀 Getting Started
6
9
@@ -40,24 +43,36 @@ Make sure you have the following installed:
40
43
npm run devStart
41
44
```
42
45
46
+
- This uses **nodemon**, so it will automatically restart the server whenever you make code
47
+
changes.
48
+
- ⚠️ If you are testing the **file rename** functionality, use the following instead to avoid
49
+
rename permission related issues:
50
+
51
+
```bash
52
+
npm run start
53
+
```
54
+
43
55
This will start the backend server on `http://localhost:3000`.
44
56
45
57
###  API Documentation
46
58
47
-
The API documentation is generated through **Swagger** and can be viewed [here](https://app.swaggerhub.com/apis-docs/SaifullahZubair/file-system_api/1.0.0).
59
+
The API documentation is generated through **Swagger** and can be viewed
You can download and use the Postman collection from [here](https://github.com/user-attachments/files/17149486/File.Management.API.postman_collection.json).
74
+
You can download and use the Postman collection from
@@ -72,7 +87,8 @@ The backend supports the following file system operations:
72
87
- **✏️ Rename a File or Folder**: `/rename`
73
88
- **🗑️ Delete File(s) or Folder(s)**: `/`
74
89
75
-
Refer to the [Swagger Documentation](http://localhost:3000/api-docs/) for detailed request/response formats.
90
+
Refer to the [Swagger Documentation](http://localhost:3000/api-docs/) for detailed request/response
91
+
formats.
76
92
77
93
## 🗂️ Folder Structure
78
94
@@ -110,7 +126,8 @@ backend/
110
126
111
127
### 📁 Uploads and Folder Creation
112
128
113
-
- All uploaded files and folders created through the API are placed in the `/public/uploads/` directory. Ensure this directory has the appropriate permissions set to allow file storage.
129
+
- All uploaded files and folders created through the API are placed in the `/public/uploads/`
130
+
directory. Ensure this directory has the appropriate permissions set to allow file storage.
0 commit comments