This repo is a backend assignment test for investax.

A few things to note in the project:

• Typescript - Typescript is the first citizen in this project.
• eslint-config-standard-with-typescript - The code linting created by Standard.js for TypeScript that is based on eslint-config-standard and has TypeScript specific rules from @typescript-eslint/eslint-plugin.
• TypeORM - A Simplified Database Query with ORM.
• Joi - For declarative payload validation.
• Winston Logger - Uses winston as the logger for the application.
• Jest - Using Jest for running test cases.
• supertest - E2E API Testing.
• swagger - API documentation using OpenAPI 3.0 Spec

You need to set up your development environment before you can do anything.

Install Node.js and NPM

• on OSX use homebrew brew install node
• on Windows use chocolatey choco install nodejs

Install yarn globally

yarn global add yarn

Fork, Clone or download this project. Configure your package.json for your new project.

Then copy the .env.default file and rename it to .env.

Then setup your application environment.

yarn install

This installs all dependencies with yarn

Go to the project dir and start your app with this yarn script.

yarn start

Running the above commands results in

• API Server running at http://localhost:8888
• Swagger UI at http://localhost:8888/dev/api-docs

This starts a local server using nodemon, which will watch for any file changes and will restart the server according to these changes. The server address will be displayed to you as http://localhost:8888.

+-- __test
|   +-- errors
|   |   |   +-- ApplicationError.test.ts
|   +-- middleware
|   |   |   +-- request-middleware.test.ts
|   +-- app.test.ts
+-- app
|   +-- controllers
|   |   +-- book
|   |   |   +-- add.ts
|   |   |   +-- all.ts
|   |   |   +-- index.ts
|   |   |   +-- search.ts
|   +-- errors
|   |   +-- index.ts
|   +-- middleware
|   |   +-- request-middleware.ts
|   +-- models
|   |   +-- Book.ts
|   +-- app.ts
|   +-- mongo-connection.ts
|   +-- routes.ts
|   +-- server.ts
+-- lib
|   +-- cors.ts
|   +-- logger.ts
|   +-- typeorm.ts
+-- scripts
|   +-- dev.sh
+-- .env
+-- .env.default
+-- .eslintignore
+-- .eslintrc.json
+-- .gitignore
+-- docker-compose.yml
+-- Dockerfile
+-- jest.config.js
+-- nodemon.json
+-- openapi.json
+-- yarn.lock
+-- package.json
+-- README.md
+-- tsconfig.json

• Install all dependencies with yarn install

• Run code quality analysis using yarn lint. This runs tslint.
• There is also a vscode task for this called lint.

• Run the unit tests using yarn test (There is also a vscode task for this called test).

• Run swagger api documentation via this link http://localhost:8888/dev/api-docs

Please be aware that Api documentation only appear in development environment