Merge pull request #81 from mskian/main

feat(route): ✨ Add Pronounce Route to API

Author: mcnaveen

.all-contributorsrc

@@ -11,9 +11,11 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/8493007?v=4",
       "profile": "https://github.com/mcnaveen",
       "contributions": [
+        "bug",
         "code",
         "data",
         "doc",
+        "example",
         "ideas",
         "maintenance",
         "review"
@@ -49,5 +51,6 @@
   "projectOwner": "mcnaveen",
   "repoType": "github",
   "repoHost": "https://github.com",
-  "skipCi": true
+  "skipCi": true,
+  "commitConvention": "none"
 }

.vercelignore

@@ -12,4 +12,5 @@ test.js
 app.js
 renovate.json
 proxy.js
-.env
+.env
+test

README.md

@@ -1,6 +1,7 @@
 # Random Words API
+
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ![build-test](https://github.com/mcnaveen/Random-Words-API/workflows/build-test/badge.svg)
@@ -11,13 +12,15 @@
 
 - Free API - `https://random-words-api.vercel.app/word`
 - Dutch Random Words - `https://random-words-api.vercel.app/word/dutch`
+- Get Pronunciation for a Word - `https://random-words-api.vercel.app/pronounce/`
 
 - PWA Demo - [Check Here](https://words.sanweb.info/)
 
 ## 🎛 Route Options
 
 - Base URL: `https://random-words-api.vercel.app/word`
-```html
+
+```text
 - /noun
 - /sentence
 - /question
@@ -35,6 +38,9 @@
 
 ## 🌐 Sample API Response
 
+- API: `https://random-words-api.vercel.app/word/`
+- Method: `GET`
+
 ```json
 [
   {
@@ -46,6 +52,10 @@
 ```
 
 ## 🌐 Sample Dutch Response
+
+- API: `https://random-words-api.vercel.app/word/dutch`
+- Method: `GET`
+
 ```json
 [
   {
@@ -56,6 +66,30 @@
 ]
 ```
 
+## 🌐 Sample Pronunciation Request
+
+- API: `https://random-words-api.vercel.app/pronounce`
+- Method: `POST`
+
+```sh
+POST http://localhost:3000/pronounce
+Content-Type: application/json
+
+{
+  "word": "This is amazing"
+}
+```
+
+## 📣 Sample Pronunciation Response
+
+```json
+{
+  "pronunciation": "this is amasink"
+}
+```
+
+- Check [api.rest](/test/api.rest) file for more details
+
 ## 💡 Learn New word
 
 - [Join Telegram Channel](https://t.me/learnwordoftheday)
@@ -81,42 +115,50 @@ yarn start
 
 OneClick Deploy on Heroku
 
-[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/mcnaveen/Random-Words-API)  
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/mcnaveen/Random-Words-API)
 
 ## 🔀 Deploying to Vercel
 
 OneClick Deploy on Vercel
 
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fmcnaveen%2FRandom-Words-API.git)  
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fmcnaveen%2FRandom-Words-API.git)
 
 OR
 
 ```html
 - Fork the Repo
 - Login to Vercel (https://vercel.com/dashboard)
 - Click Import Project
-- Give Forked Repo URL
-- Go Live
+- Give Forked Repo URL - Go Live
 ```
 
-## ✍️ Commit
+## :question: How to Contribute?
+
+Make your changes and follow the below instructions. We follow conventional commits.
+
+### ✍️ Commit
 
 - Stage all changes
-```
+
+```sh
 git add .
-``` 
-- Commit the changes
 ```
+
+- Commit the changes
+
+```sh
 yarn commit
 ```
+
 - Push the changes to GitHub
-```
+
+```sh
 git push <TO YOUR FORK>
 ```
 
 ## ⚛ CREDITS
 
-- Thanks to [Santhosh Veer](https://github.com/mskian) for Progressive Web APP - [Source Code](https://github.com/mskian/vue-random-words)  
+- Thanks to [Santhosh Veer](https://github.com/mskian) for Progressive Web APP - [Source Code](https://github.com/mskian/vue-random-words)
 
 ## ☑ LICENSE
 
@@ -139,6 +181,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
+    <td align="center"><a href="https://github.com/mcnaveen"><img src="https://avatars.githubusercontent.com/u/8493007?v=4?s=100" width="100px;" alt=""/><br /><sub><b>MC Naveen</b></sub></a><br /><a href="https://github.com/mcnaveen/Random-Words-API/issues?q=author%3Amcnaveen" title="Bug reports">🐛</a> <a href="https://github.com/mcnaveen/Random-Words-API/commits?author=mcnaveen" title="Code">💻</a> <a href="#data-mcnaveen" title="Data">🔣</a> <a href="https://github.com/mcnaveen/Random-Words-API/commits?author=mcnaveen" title="Documentation">📖</a> <a href="#example-mcnaveen" title="Examples">💡</a> <a href="#ideas-mcnaveen" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-mcnaveen" title="Maintenance">🚧</a> <a href="https://github.com/mcnaveen/Random-Words-API/pulls?q=is%3Apr+reviewed-by%3Amcnaveen" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://github.com/jonah-butler"><img src="https://avatars.githubusercontent.com/u/18040568?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jonah-butler</b></sub></a><br /><a href="https://github.com/mcnaveen/Random-Words-API/commits?author=jonah-butler" title="Code">💻</a> <a href="https://github.com/mcnaveen/Random-Words-API/commits?author=jonah-butler" title="Documentation">📖</a></td>
     <td align="center"><a href="https://santhoshveer.com/"><img src="https://avatars.githubusercontent.com/u/10300271?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Santhosh Veer</b></sub></a><br /><a href="https://github.com/mcnaveen/Random-Words-API/commits?author=mskian" title="Code">💻</a> <a href="https://github.com/mcnaveen/Random-Words-API/commits?author=mskian" title="Documentation">📖</a> <a href="#ideas-mskian" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-mskian" title="Maintenance">🚧</a> <a href="https://github.com/mcnaveen/Random-Words-API/issues?q=author%3Amskian" title="Bug reports">🐛</a> <a href="https://github.com/mcnaveen/Random-Words-API/pulls?q=is%3Apr+reviewed-by%3Amskian" title="Reviewed Pull Requests">👀</a></td>
   </tr>
@@ -149,4 +192,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

index.js

@@ -4,10 +4,27 @@ const app = express();
 import home from './routes/home.js';
 import en from './routes/en.js';
 import dutch from './routes/dutch.js';
+import pronounce from './routes/pronounce.js';
 
 app.use('/', home);
 app.use('/word/dutch', dutch);
 app.use('/word', en);
+app.use('/pronounce', pronounce);
+
+app.use('/', function(req, res) {
+    res.status(404).json({
+        error: 1,
+        message: 'Page or Data not Found'
+    });
+})
+
+app.use((err, req, res, next) => {
+    if (!err) return next();
+    return res.status(403).json({
+        error: 1,
+        message: 'Page or Data not Found'
+    });
+});
 
 var port = process.env.PORT || 3000;
 app.listen(port, function() {

package.json

@@ -15,9 +15,11 @@
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
 		"start": "node index.js",
-		"action": "node test.js",
+		"action": "node ./test/test.js",
 		"dev": "nodemon index.js --ext '*'",
-		"commit": "gacp"
+		"commit": "gacp",
+		"contributors:add": "all-contributors add",
+		"contributors:generate": "all-contributors generate"
 	},
 	"type": "module",
 	"keywords": [
@@ -37,6 +39,7 @@
 	"author": "MC Naveen",
 	"license": "MIT",
 	"devDependencies": {
+		"all-contributors-cli": "^6.20.0",
 		"gacp": "^3.0.2",
 		"nodemon": "^2.0.19"
 	},

routes/pronounce.js

@@ -0,0 +1,30 @@
+import express from "express";
+import { pronounce } from "node-pronounce";
+const router = express.Router();
+
+router.use(express.json());
+
+router.post("/", function (req, res) {
+  res.header("Access-Control-Allow-Origin", "*");
+  res.header(
+    "Access-Control-Allow-Headers",
+    "Access-Control-Allow-Headers,Content-Type,Access-Control-Allow-Methods, Authorization, X-Requested-With"
+  );
+  res.header("Access-Control-Allow-Methods", "GET");
+  res.header("X-Frame-Options", "DENY");
+  res.header("X-XSS-Protection", "1; mode=block");
+  res.header("X-Content-Type-Options", "nosniff");
+  res.header("Strict-Transport-Security", "max-age=63072000");
+  res.setHeader("Content-Type", "application/json");
+
+  var userWord = encodeURIComponent(req.body.word) || "Hello World";
+  if (userWord == "undefined") {
+    res.status(400).json({ pronunciation: "Empty data" });
+  } else {
+    let wordData = pronounce(userWord);
+    const pronouncedWord = decodeURIComponent(wordData);
+    res.status(200).json({ pronunciation: pronouncedWord });
+  }
+});
+
+export default router;

test/api.rest

@@ -0,0 +1,6 @@
+POST http://localhost:3000/pronounce
+Content-Type: application/json
+
+{
+  "word": "This is amazing"
+}