Building Code Runner - Part #2 : Node.js Backend With Express Server and JDoodle API

Building Code Runner - Part #2 : Node.js Backend With Express Server and JDoodle API

Building a backend server application using Node.js, Express and JDoodle API to execute scripts and return the output as response.

Hello everyone ๐Ÿ‘‹๐Ÿฝ

Here is the third article in our series, CodeRunner. I am pretty much excited to get us started. Let's dive in ๐Ÿคฉ

This article will speak about 2 things:

  1. JDoodle API

  2. Using Express and Node.js

Introduction to the JDoodle API

JDoodle is an online compiler and editor just like our CodeRunner, built and maintained by @thenutpan. They also provide an API as a service to run scripts, by spending credits.

The pricing is pretty much reasonable and the free plan should help you get started for a personal project like this. You will be provided with 200 credits per day, which means 200 API calls per day. On signing up for the API, you will be provided with a client key and client secret which will be used for authenticating the API calls, so keep them handy.

The entire documentation for the API can be found here. We will be using the execute API for now.

Using Express and Node.js

Our application will be built on Node.js with express as our server. Do follow the steps in the previous part of the series before proceeding further.

  1. Create the required files and folders in your server directory to match the below directory structure.
    • The index.js will be the entry point to our server.
    • The controllers folder will contain all the functions that shall be executed on the server.
    • The models folder consists of the Mongoose models (will be discussed in the next part).
    • The routes folder consists of the server routes which will point to a function based on the path.
      โ””โ”€โ”€ server
      โ”œโ”€โ”€ controllers
      โ”‚   โ””โ”€โ”€ methods.js
      โ”œโ”€โ”€ index.js
      โ”œโ”€โ”€ models
      โ”‚   โ””โ”€โ”€ codes.js
      โ”œโ”€โ”€ node_modules 
      โ”œโ”€โ”€ package.json
      โ””โ”€โ”€ routes
         โ””โ”€โ”€ paths.js
  2. Express is a framework which enables web server capabilities to the Node.js. To get started, we will import the express library in our index.js file and create an express app as follows.
    const express = require("express");
    const app = express();
  3. To test our app, let's have a dummy route at / which returns a simple message.
    app.get("/", (req, res) => {
    return res.status(200).json({ message: "Up & Running " });
    Whenever a user reaches the / route of the app, they will be served with the message as response, showing that the server is active.
  4. The app should be running and for that we need to provide a port, as follows.
    const port = process.env.PORT || 8000;
    app.listen(port, () => {
    console.log(`App is running on PORT : ${port}`);
    Here, process.env.PORT refers to the PORT environment variable which will be setup by the hosting providers. In the case of it's absence, the application will run on port 8000.

    To enable the usage of environment variables, we will need to use the dotenv library as follows and it should be line #1 of the program.
  5. To enable JSON capabilities to our application, we will need the body-parser library, so import it and use it in the app as follows.

    const bodyParser = require("body-parser");

    This sets up the entry point for the application.

  6. Moving on to routes, the paths.js file shall contain the routes of the application and map it them to the controllers. It is easy to debug large application, by having the routes on a different folder.
    The Express library provides the Router instance, that can be used to define the router paths. To begin, import express and the express Router as follows.

    const express = require("express");
    const router = express.Router();
  7. Now, define the routes for the application based on the mind map and map them to the controller to execute and export them once ready. We need to import the controllers first and the code is as follows:
    const controller = require("../controllers/methods");
    router.get("/getCode", controller.getCode);"/runCode", controller.runCode);"/saveCode", controller.saveCode);
    module.exports = router;
    With this, we have our routes ready.

Code can be found here

The controller and its methods along with the MongoDB functionality shall be discussed in the next part of the series.

Do subscribe to the newsletter to not miss a new article. ๐Ÿ“ซ

Stay safe everyone โค

Until next time,