/loox

Primary LanguageJavaScript

Roy Segall Loox Task

Hi, this is my solution for the task of the un-usual pets.

Set up

As always:

npm i
cp .env.example .env

By default, the pets will be pulled from the files which located under src/data. But, if you want to use a DB as the data source open the .env file and change the driver to db. Then, change the mongoDBURL and mongoDBName to meet you local env setup. Then, you'll need to seed the DB:

npm run db:seed

Running the server

All you need to do is:

npm dev

Adding more pets

In src/data add a json file which goes by the next format:

{
  "name": "Name of the pet",
  "picture": "image_name.png",
  "fileInfo": "markdown_file_name.md"
}
  • name - This is the name of the pet.
  • picture - A filename of the pet's picture. All the pet's images located under public/images
  • fileInfo - This is a file in a markdown format and need to be located under src/data

todo

There are alot of stuff I wanted to do:

  • Unit test with Jest
  • Testing the express server
  • Running E2E test with cypress
  • Add visual regression
  • Dockerising the small app