firashrs/API-Tunsian-Dialect-English-Words

An API for Tunisian Dialect to English Words # API-Tunsian-Dialect-English-Words An API for Tunisian Dialect to English Words # Routes details The API have 4 different routes. All of which are GET methods: * Getting the list of all the words * Getting a single word by id * Getting the Tunisian translation of a searched English word * Getting the English translation of a searched Tunisian word ## Getting the list of all the words the full list of all the words and their translation contains over 6,000 enteries. the URI for getting the full list: ``` /api/words/ ``` ## Getting a word by its ID An ID is a unique value defining each entry. the URI for getting a word by its ID: ``` /api/words/:id ``` ## Getting the Tunisian translation of a searched English word Every English word has a Tunisian translation and a nunated version of the word. the URI for getting a Tunisian translation of a searched English word: ``` /api/words/en-tn/:english_word ``` ## Getting the English translation of a searched Tunisian word Every Tunisian word has a an English translation and a nunated version of the orginal word. the URI for getting a Tunisian translation of a searched English word: ``` /api/words/tn-en/:tunisian_word ``` # Usage The project is using NPM to manage pckges. So, the package json files contain all the necessary npm packages used by the project. Weather locally or on a remote server, the installation process is done by running the command: ``` npm install ``` To run the API , the next command should be executed: ``` npm start ```