Skip to content

Commit 810494e

Browse files
committed
update readme
1 parent dcf31b2 commit 810494e

File tree

86 files changed

+463
-70
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+463
-70
lines changed

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,26 @@ This project aims to create a cloud-based secure and easy-to-use mechanism for m
4040

4141
## How To Use
4242
The project contains three main components:
43-
* The database server ([data_service](data_service))
44-
* The web application ([admin_console](admin_console))
45-
* The content uploader application ([content_uploader](content_uploader))
43+
* The database server ([data_service](src/data_service))
44+
* The web application ([admin_console](src/admin_console))
45+
* The content uploader application ([content_uploader](src/content_uploader))
46+
47+
The file structure of the project is as follows:
48+
```
49+
.
50+
├── src/
51+
│ ├── admin_console/ (The web application for management of import data)
52+
│ ├── content_uploader/ (Frontend for supporting import of files into the database)
53+
│ ├── data_service (The main database server hoster)
54+
│ └── db_updater (Application to parse files and update the database)
55+
└── scripts/
56+
├── db/ (Database schema and other scripts)
57+
└── service/
58+
├── data_service.sh (The script to start the database server on Linux system)
59+
├── install_service.bat
60+
└── learndb.service (The service file of the database server for linux system)
61+
```
62+
4663

4764
In order to setup the project in a new environment, the prerequisites are:
4865
* Python 3.9+

content_uploader/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

index.html

Lines changed: 0 additions & 1 deletion
This file was deleted.

oldReadme.md

Lines changed: 0 additions & 65 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)