README.md 3.37 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
# Hdoc to Mongo (`hdoc_to_mongo`)

## License
License GPL3.0
http://www.gnu.org/licenses/gpl-3.0.txt

## Credits
Alexandre Thouvenin
Kapilraj Thangeswaran

## Presentation
This module is able to extract data from a file in Hdoc format and insert them into MongoDB.

## Dependencies
15 16
In order to work properly this module needs :
- to download and install Node.js
17
    - For windows :
18
        - from the [Node.js download page](https://nodejs.org/en/)
19
    - For linux (instruction for debian 8, may vary depending on your distrbution) execute the followings commands :
20 21 22 23
        - `su`
        - `apt install nodejs`
        - `apt install node`
        - `apt install npm`
24
		- `npm link mongodb` from hdoc_to_mongo folder
25 26

- to download and install MongoDB 
27
    - For Windows :
28
        - from the [MongoDB download page](https://www.mongodb.com/download-center#community)
29
    - For linux : 
30
        - `su & apt install mongodb`
Kapilraj Thangeswaran's avatar
Kapilraj Thangeswaran committed
31

32
## Instructions
33
1. Install dependencies
34 35 36
2. Add all your hdoc documents in an "input" folder
3. Add or edit "config.xml" file in "input" folder (for more details, please check "Input configuration")
4. Edit "config.json" file from "mongo" folder (for more details, please check "Mongo configuration")
37
5. Make sure that MongoDB is running (`mongod.exe --rest --jsonp` command from "MongoDB/Server/3.2/bin" folder)
38
6. Execute run.bat or chmod +x run.sh & ./run.sh
39

40 41 42 43 44 45
## Web
This module provides a Web application to access MongoDB and execute simples requests.
1. Launch MongoDB using `mongod.exe --rest --jsonp` command from "MongoDB/Server/3.2/bin" folder.
2. Edit "config.json" file from "web" folder (for more details, please check "MongoDB configuration")
3. Open "index.html" in "web" folder

46 47 48 49 50 51 52
## Input configuration
You can add or edit "config.xml" in "input" folder in order to provide more information about your documents.
Supported information
- link
```
<?xml version="1.0" encoding="UTF-8"?>
<config>
53
	<file name='sample.scar'>
54 55 56 57 58
		<link>https://stph.scenari-community.org/nf17/co/nf17.html</link>
	</file>
</config>
```

59 60
## MongoDB configuration
### In "mongo" folder
61
Use "config.json" in the "mongo" folder to specify
62 63 64 65
- url : mongodb's url
- database : the database you are using
- collection : the collection you are using
- request : the request you want to perform (for allowed requests, please check "Supported requests")
66
```
67 68 69 70 71 72 73 74 75
{
	"url" : "mongodb://localhost:27017/",
	"database" : "database",
	"collection" : "collection",
	"request" : "insert"
}
```

### In "web" folder
76
Use "config.json" in the "web" folder to specify
77
- url : mongodb's url including the database
78
- collection : the collection you are using
79
```
80
{
81
	"url" : "mongodb://localhost:27017/database",
82 83 84
	"collection" : "collection",
}
```
85 86 87

## Supported requests
- insert
88 89
- update (using the title as filter)
- remove (using the title as filter)
90

Kapilraj Thangeswaran's avatar
Kapilraj Thangeswaran committed
91
## User stories
92 93
- En tant qu’utilisateur rédigeant des documents sous opale, je veux récupérer les exercices corrigés d’un sujet donné dans le but de les réutiliser.
- En tant qu’utilisateur rédigeant des documents sous opale, je veux récupérer les cours d’un auteur précis dans le but d’utiliser ses cours comme références.
94
- En tant qu’utilisateur universitaire, je souhaite mettre à disposition mes exercices sur internet de manière structuré dans le but de permettre à d’autre utilisateurs universitaires de les trouver, par thème, auteur ou contenu et de les réutiliser.