This repo should work as a starting point for any backend service project requiring a UI part.
Running the project using workspace:
First you must clone the project.
$ make clone service=ui-boilerplate
You'll notice there are two services that are cloned. This is because the boilerplate's service definition in the workspace's docker-compose.yml
includes a depends-on
rule that ties it to the component-library. The purpose of this rule is to enable the boilerplate to hot reload when changes are made on the component library.
To bring up both services and make use of this feature, simply run:
$ docker-compose build --build-arg LIB_DIR=/component-library ui-boilerplate
$ docker-compose up ui-boilerplate
If you wish to build the ui-boilerplate without using the symlink, simply run:
$ docker-compose up -d --build ui-boilerplate
$ docker-compose stop ui-component-library
Upon successfully bringing up the boilerplate image as a container, the following line should be displayed:
ui-boilerplate_1 | ℹ 「wdm」: Compiled successfully.
In order to run the project locally, simply run:
$ npm install
$ npm run start
...and start writting some code.
- React 16.X
- Webpack 4.X
- Docker
- Docker compose
- Ssense Component Library