Skip to content

Commit 696f8ea

Browse files
committed
Update README.md
1 parent ad30ce8 commit 696f8ea

File tree

1 file changed

+8
-61
lines changed

1 file changed

+8
-61
lines changed

README.md

Lines changed: 8 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,75 +2,22 @@
22

33
Open-source **Django** project crafted on top of **[Corporate Dashboard](https://appseed.us/product/corporate-dashboard/django/)**, an open-source `Bootstrap 5` design from [Creative-Tim](https://www.creative-tim.com/product/corporate-ui-dashboard?AFFILIATE=128200).
44
Designed for those who like bold elements and beautiful websites. Made of hundred of elements, designed blocks and fully coded pages, `Corporate Dashboard` is ready to help you create stunning websites and webapps.
5-
6-
> **STATUS**: `Work in Progress`
75

86
<br />
97

10-
## File Manager
11-
12-
The codebase needs to be enhanced to manage all files saved in the media directory. For instance, the following structure might exist:
13-
14-
> **Disk Storage** (Files Exlorer)
15-
16-
```bash
17-
<ROOT>
18-
|-- media
19-
|-- project1
20-
| |-- photo.jpg
21-
| |-- cv.pdf
22-
| |-- dir1/
23-
| |-- readme.txt
24-
|
25-
|-- project2
26-
|-- my-data.png
27-
|-- reports.xls
28-
```
29-
30-
The route that handles the files needs to be like this:
31-
32-
- `/file-manager/` - the root of the `MEDIA` directory is managed
33-
- `/file-manager/project1/` only the files and subdirectories of `project1` are managed
34-
35-
> **UI** (Files Exlorer)
36-
37-
The UI will provide a `left`, `right` view, using a pattern similar to Windows File Explorer:
38-
39-
- **left panel** shows directories
40-
- the user can collapse the tree structure
41-
- **right panel**
42-
- shows the current files of the selected directory (on the right panel)
43-
- ACTIONS:
44-
- delete
45-
- view (modal popup) for formats: PNG, JPG, PDF, CSV
46-
- download
47-
- upload
48-
49-
<br />
8+
> Features:
509
51-
![Django Corporate Dashboard](https://user-images.githubusercontent.com/51070104/229719846-cfe96c5c-89c2-4ea0-89a9-7be69ebbb228.png)
10+
- ✅ Simple `File Manager` over the MEDIA folder
11+
- Supports any Depth TREE
12+
- Options: delete, preview, download, upload
13+
-`Up-to-date Dependencies`
14+
- ✅ Theme: [Django Admin Corporate](https://github.com/app-generator/django-admin-corporate), designed by [Creative-Tim](https://www.creative-tim.com/product/corporate-ui-dashboard?AFFILIATE=128200)
15+
- `can be used in any Django project` (new or legacy)
16+
-**Authentication**: `Django.contrib.AUTH`, Registration
5217

5318
<br />
5419

55-
## Start with `Docker`
56-
57-
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
58-
59-
```bash
60-
$ git clone https://github.com/app-generator/sample-django-file-manager.git
61-
$ cd sample-django-file-manager
62-
```
63-
64-
<br />
65-
66-
> 👉 **Step 2** - Start the APP in `Docker`
67-
68-
```bash
69-
$ chmod +x entrypoint.sh
70-
$ docker-compose up --build
71-
```
7220

73-
Visit `http://localhost:5085` in your browser. The app should be up & running.
7421

7522
<br />
7623

0 commit comments

Comments
 (0)