- run
npm installoryarnto install all the packages - run
npm run devto run the application in the development environment - run
npm run buildto build the app in a production setting - run
npm startto start and run the API - in order to test the application code
npm run testcan be used. In case if any caching problems or tests not running completely just pressato run all the tests, and run the test command with-- --clearCache - and in order to get the coverage report of the test one can use
npm run test:coverage - one can change the base url of the shortened service in the
.envfile
OPEN API SPECIFICATION has been followed to document the routes (this can be seen in the routes file with .yaml file and within route file as comments), but in order to build and host it one need another tools, which is not implemented, but one can easily do it with the following packages:
- openapi-comment-parser (1.0.0)
- swagger-ui-express (for front end hosting)
One can also use docusaurus which is considered modern
Database is not considered, but one can easily change up the implementation within the data-access folder and bring in database
Following packages are used for better development workflow:
- prettier
- commitlint
- husky
- eslint
And the following tools can be introduced to make the development much more easier;
- docker
The following code piece can be implemented for better performance and optimization:
rate limiting- to secure the API calls from DDoS- a
redis cache layer, to reduce the hit on the DB layer (if one is implemented later on)
curl -d '{"url": "https://www.example.com"}' -X POST -H 'Content-Type: application/json' http://localhost:3000/api/1.0/dev/url/encode- response :
{url: "https://short.est/OCscMSicYJ"}
curl -d '{"url": "https://short.est/OCscMSicYJ"}' -X POST -H 'Content-Type: application/json' http://localhost:3000/api/1.0/dev/url/encode- response :
{url: "https://www.example.com"}