README.md 3.31 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 17 18 19 20 21 22 23 24 25 26 27 28 29
In order to work properly this module needs :
- to download and install Node.js
    For windows :
        - from the [Node.js download page](https://nodejs.org/en/)
    For linux (instruction for debian 8, may vary depending on your distrbution) execute the followings commands :
        - `su`
        - `apt install nodejs`
        - `apt install node`
        - `apt install npm`

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

31
## Instructions
32
1. Install dependencies
33 34 35
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")
36
5. Make sure that MongoDB is running (`mongod.exe --rest --jsonp` command from "MongoDB/Server/3.2/bin" folder)
37
6. Execute run.bat or chmod +x run.sh & ./run.sh
38

39 40 41 42 43 44
## 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

45 46 47 48 49 50 51
## 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>
52
	<file name='sample.scar'>
53 54 55 56 57
		<link>https://stph.scenari-community.org/nf17/co/nf17.html</link>
	</file>
</config>
```

58 59
## MongoDB configuration
### In "mongo" folder
60
Use "config.json" in the "mongo" folder to specify
61 62 63 64
- 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")
65
```
66 67 68 69 70 71 72 73 74
{
	"url" : "mongodb://localhost:27017/",
	"database" : "database",
	"collection" : "collection",
	"request" : "insert"
}
```

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

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

Kapilraj Thangeswaran's avatar
Kapilraj Thangeswaran committed
90
## User stories
91 92
- 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.
93
- 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.