This API service provides data for smartcar challange

Database

• Install Node.js
• Install npm

• Clone the repository

git clone [email protected]:ezos86/smartcar-be.git

• Install dependencies

cd <project_name>
npm install

• Build and run the project

npm start

Navigate to http://localhost:8001

• API Document endpoints

  swagger-ui Endpoint : http://localhost:8080/docs

Add Typescript to project npm.

npm install -D typescript

The folder structure of this app is explained below:

Consitency amongst file, function and variable names makes it easier to search the codebase when looking for a file, value, or function. It can quickly be understood based on the case, rather it's a function or variable if we follow these assignment rules.

• File names should be in kabob case and include the target file type: ex: hello-world.route.ts or hello-world.controller.ts
• Function names should be in lower camel case: ex: getPredictionData or updateUser
• Variable names should be in snake case: ex: prediction_data or first_name

{
    "compilerOptions": {
      "target": "es5",
      "module": "commonjs",
      "outDir": "dist",
      "sourceMap": true
    },
    
    "include": [
      "src/**/*.ts"
      

    ],
    "exclude": [
      "src/**/*.spec.ts",
      "test",
      "node_modules"
    
    ]
  }

All the different build steps are orchestrated via npm scripts. Npm scripts basically allow us to call (and chain) terminal commands via npm.

The tests are written in Mocha

"mocha": "3.4.2",
"chai": "4.1.2",
"chai-http": "3.0.0",

import chaiHttp = require("chai-http")
import * as chai from "chai"
import app from './application'

const expect = chai.expect;
chai.use(chaiHttp);


describe('App', () => {
  it('works', (done:Function): void => {
  chai.request(app)
      .get('/api/hello?greeting=world')
      .send({})
      .end((err:Error, res: any): void => {
          
          expect(res.statusCode).to.be.equal(200);
          expect(res.body.msg).to.be.equal("hello world");
          done();
      });
  
    });
});

npm run test

Test files are created under test folder.

The swagger specification file is named as swagger.yaml under /docs.

TSLint is a code linter that helps catch minor code quality and style issues.

All rules are configured through tslint.json.

To run TSLint you can call the main build script or just the TSLint task.

npm run build:live   // runs full build including TSLint
npm run lint  // runs only TSLint