felipegtx / cozy

:crystal_ball: Code playground (ThreeJs, TypeScript, Docker, Moca, Swagger, etc..)

cozy

Feeling Cozy already?

First things first

• npm install

Running this project

You basically have two options.

1. Compile and start by hand

• tsc -p tsconfig.json
• node src\index.js

2. Compile and start using VSCode

• Hit F5 using the "Launch Program" profile.

Runing the tests

Not that we have that many, but you also have two options

1. Run tests by hand

• If this is your very first time here, you'll need to run a quick: tsc -p tsconfig.json
• mocha ./src/tests/getDesignByUserIdTests.js

2. Use VSCode to run the tests

• Open the test file and hit F5 using the "Mocha Current File" profile.

Docker

• Get your awsKey and awsSecret from the ~/.aws/credentials file and use it to build the docker Image: docker build --build-arg awsKey=yourkey --build-arg awsSecret=yourSecret -t cozyo .
• Start the docker container: docker run --name cozy -p 8081:8080 cozyo

Default login information

To authenticate in the app you can use the following credentials or create a new one:

• Email: [e-mail]
• Password: cozyLife

What can I do with this?

You could either...

• View the test data at:
  • http://localhost:8080/design/1234?budget=anything&room_type=anything&limit=10&q_api_key=12345
• Visit the awesome room at:
  • http://localhost:8080/
• Play with the number of items rendered/returned using the limit parameter in the URL:
  • http://localhost:8080/?limit=2
  • http://localhost:8080/design/1234?budget=anything&room_type=anything&limit=2&q_api_key=12345

PS: Remember to change the port to 8081 when running from Docker.

API Reference

• Swagger

Extra info