This application is a technical test project for senior backend software engineer role of Getir.

Before start you can access backend rest api online from here.

Before we begin, make sure you have NodeJs version >=12.* and Express version ^4.17.1.

$ node -v # node v12.10.0
$ express --version # Express 4.16.1

As you know Nodejs utilizes npm to manage its dependencies. So, before starting setup our app, make sure you have npm installed on your machine.

You can check if you have

$ which npm

To update to its latest version with:

$ npm update --system

First step, we need to clone rest api repo to your local machine.

$ git clone https://github.com/akingundogdu/getir-case-study.git

After that, go to inside directory your cloned path and running this command.

$ npm install

Let's take a moment to review the npms that we used.

• Express - Fast, unopinionated, minimalist web framework for Node.js.

• dotenv - Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env. Storing configuration in the environment separate from code is based on The Twelve-Factor App methodology.

• express-validator - express-validator is a set of express.js middlewares that wraps validator.js validator and sanitizer functions.

• mongoose - Mongoose provides a straight-forward, schema-based solution to model your application data. It includes built-in type casting, validation, query building, business logic hooks and more, out of the box.

• jest - Jest is a delightful JavaScript Testing Framework with a focus on simplicity.

• mongodb-memory-server - Spinning up mongod in memory for fast tests. If you run tests in parallel this lib helps to spin up dedicated mongodb servers for every test file in MacOS, *nix, Windows or CI environments (in most cases with zero-config).

• nodemon - Nodemon is a utility that will monitor for any changes in your source and automatically restart your server. Perfect for development. Install it using npm.

• swagger-node-express - This is a Swagger module for the Express web application framework for Node.js.

• express-swagger-generator - This is a Swagger module generator for the Express web application framework for Node.js.

In your root directory, run this command and see all tests are success, like below image

$ jest

For starting serve backend api, just you need to run this command

$ npm run dev or node start.js (without nodemon)

All done!

You can test manually with the link below.

$ https://akin-gundogdu-getir-case-study.herokuapp.com/api/records

• Nodejs
• ExpressJS
• Javascript
• Ohmzsh
• Postman
• MacOS

Thanks for reading.

• Author : Akin Gundogdu
• Email : [email protected]
• Linkedin : https://www.linkedin.co.uk/in/akingundogdu