hardikk2002/Dev-Essential-Server

This is the server code of Dev Essentials, a chrome extension. This repo is for API calling and for bidirectional chat support using socket.io with persistent chat data using MongoDB.

Dev-Essential-Server

Dev Essentials ✨️

A Chrome Extension to keep you updated with the latest happenings✨️

🔰 An Insight

Dev Essentials is a Chrome Extension built for Developers and Tech Enthusiasts, to keep them updated with the latest happenings, upcoming contests and, new tech innovations.

This Repo contains server coder of Dev Essentials

📝 Installation Requirements:

• Install git (https://git-scm.com/download/win)
• Install Nodejs (https://nodejs.org/en/download/)
• Install MongoDB (https://docs.mongodb.com/manual/installation/)
  • Alternative, Use MongoDB Atlas (MongoURI) for online database management (https://www.mongodb.com/cloud/atlas)

🛠️ Installation Steps

1. Clone the repository

git clone https://github.com/hardikk2002/Dev-Essentials.git

2. Change the working directory

cd Dev-Essential-server

3. Install dependencies

npm install

4. Build the app

nodemon start

You are all set! Open localhost:4000/ to see the message.

This server is also hosted on Heroku at devessential.herokuapp.com/🚀 So you may not want to run this explicitly if you are trying Dev Essentials at your local.

📝 API Calls

1. To Fetch Contest lists

      "https://devessential.herokuapp.com/api/contest",
      {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ resource: resource }),
      }

Resource is the name of the Platform, eg. "codechef.com", "codeforces.com", and so on...

2. To Fetch latest Apple News

     const response = await fetch(
        "https://devessential.herokuapp.com/api/news-apple"
      );

3. To Fetch latest Tesla News

      const response = await fetch(
        "https://devessential.herokuapp.com/api/news-tesla"
      );

4. To Fetch news on tech Keywords

     "https://devessential.herokuapp.com/api/news-keyword",
     {
       method: "POST",
       headers: { "Content-Type": "application/json" },
       body: JSON.stringify({
         resource: searchKey,
     })

🍰 Contributing

• Please contribute using GitHub Flow.

Create a branch, add commits, and open a pull request.

🛡️ License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Support

If you found the app helpful ❤️, Don't forget to leave a star ⭐️

🦄 Spread the word

Share on twitter with pre populated message.