YassirELATTAR/Linguistic-Roadmap-to-Darija

This is a final version of my project in the course of Text Technology for the M.Sc. in Computational Linguistic. The course is taught by Prof. Dr. Kerstin Jung at the university of Stuttgart, Germany. # Linguistic Roadmap to Darija This is a final version of our project in the course of Text Technology for the M.Sc. in Computational Linguistic. The course is taught by Prof. Dr. Kerstin Jung at the university of Stuttgart, Germany. This project is an Express.js application designed to handle various endpoints for interacting with a MongoDB database containing Darija grammar, vocabulary, and sentences. The application supports functionalities such as fetching vocabulary/grammar items and sentences, searching for vocabulary entries, retrieving spelling statistics, and contributing the database of the darija. The main functions are explained in details below with sample examples of the code in both back-end and front-end. A simple short presentation of the project can be found here. ## Table of Contents - Installation - Database Configuration - Running the server - Endpoints - GET /vocabulary/category - GET /grammar/category - GET /vocabulary/sentences - GET /search - GET /spelling-stats - Contribute - References - Acknowledgements ## Installation 1. Clone the repository: ```bash git clone git@github.com:YassirELATTAR/Linguistic-Roadmap-to-Darija.git cd Linguistic-Roadmap-to-Darija ``` 2. Install node: ```bash $ brew install node@20 ``` 3. Install the dependencies (go to step 4 if you have problems): ```bash npm install ``` 4. Remove the configuration that were retrived when cloning the repository and reinstall them in your environment: ```bash rm -rf node_modules package-lock.json ``` Try again step 3 5. Make sure you have a MongoDB instance running and update the connection URI in your environment configuration (Python code and app.js). ## Database Configuration 1. Create your database using xml/csv files: 1.1. Open/ Excute "py_db_create.py" file and run the function (to avoid problems, it is recommended to run function: from_csv_to_db(db_name, client) Make sure you edit the following if you have different values for the connection string (it is not re …