Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 2.5 KB

README.md

File metadata and controls

83 lines (59 loc) · 2.5 KB
Raw

ML Front-End Test

ML Front-End Test Application

Status License React Release

❗️Requirements

  • React >= 16.13.1
  • npm >= 6.13.4

⬇️ Version

2.0.0

🛠 Installation

Download zip file and extract it latest release. Or clone the repository and cd into it.

ML Front-End Test uses a number of open source projects to work properly:

  • React - A JavaScript library for building user interfaces
  • Storybook - Storybook is an open source tool for developing UI components in isolation for React, Vue, and Angular.

Install the dependencies and start the server.

cd ml-frontend-test
npm install

🚀 Running with NPM

Run the following command to start the HTTP Server.

cd ml-frontend-test
cp .env.example .env # If you don't have .env file you can use the example one. Just rename .env.example to .env. Enter your configuration here.
npm start # Run React App
npm test # Run tests
npm run storybook # Run Storybook Server

🐳 Running it with Docker

cd ml-frontend-test
cp .env.example .env # If you don't have .env file you can use the example one. Just rename .env.example to .env. Enter your configuration here.
docker-compose build
docker-compose -f docker-compose.yml up -d
docker-compose ps
docker-compose down -v # Bring down the development containers (and the associated volumes with the -v flag)

👁 Preview

Demo

storybook-docs-preview

📝 Todos

  • Add code comments
  • Add missing stories (Storybook)
  • Add integration tests
  • Improve breadcrumb implementation
  • Improve mobile performance
  • Add Loader Component
  • Add pagination and filters
  • Add Dockerfile for production