dragomir-parvanov / limehome-full-stack-challenge

Information

Single repository, containing both the client and the server with one 'package.json' file and one 'node_modules' folder. For testing the nodejs dependent files I used the Mocha testing framework and the supertest testing module. For the browser dependent files I used Jasmine + Karma(the Angular CLI setup). For the database I used PostgreSQL and TypeORM.

API Documentation

https://limehome-interview-challenge.herokuapp.com/api-docs

keywords

Angular, Express, PostgreSQL, TypeORM, fp-ts, io-ts, Mocha, Jasmine, Karma, supertest, Swagger

Known issues

The swiper would not work on some devices, because I restricted myself of using third party module like Swiper.js. I ended up using the 'IntersectionObserver' API, but it shows that it does not work on some devices and needs additionally tweaking. It is working on the latest chrome desktop version, with the mobile inspector on.

Instalation

The project uses yarn instead of npm. The project was developed and tested on Node 14.x.x and Typescript 4.x.x Just run the command 'yarn' to install all dependencies.

You will also need to specify environment files for each stage.

setup environment files

and each .env file needs to have these properties

.env file

The node applications pick the environment file, based on the process.NODE_ENV, so to specify which environment file you want to use. You have to specify it with setting the NODE_ENV environment variable prior running a command. Example on Linux and Mac:

'NODE_ENV=production yarn watch-server'

After you are done, you can run yarn build to build the server and then the client. If the building succeed, you can run yarn start to start the application.

Additional commands:

yarn watch-client - starts the client in development mode

yarn test-client - tests the client

yarn lint - checking for any linting errors

yarn watch-server - starts the server in development mode

yarn test-server - runs all .node.spec.ts tests on Mocha