Docker Explorer

Getting Started

Prerequisites

• Node
• Yarn
• Docker

Installation

Clone the project

git clone https://github.com/mecm1993/docker-explorer.git

Yarn

Install the dependencies

cd docker-explorer
yarn install

Make sure everything is working

yarn start

Docker

Create the image

cd docker-explorer
docker build -t dockerexplorer --rm .

Run the image

docker run --itd --rm -p 3000:80 --name dockerexplorer-web dockerexplorer

Docker-Compose

cd docker-explorer
docker-compose up -d --build

Note: If everything works as expected, it should be at https://localhost:3000.

Code Style

The project uses TypeScript ESLint. To make sure the code works with the format,

yarn lint

Deployment

It deploys automatically to Zeit Now when changes are pushed to the branches develop and master.

Built With

• React - JavaScript Library
• TypeScript - JavaScript typed superset
• Yarn - Package Manager
• BaseWeb - UI Framework
• Zeit Now - Cloud Platform

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

This project was inspired by GitExplorer from Summitech which is an awesome way to learn about Git.