These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Note: This is the Frontend Web part of the Controk system and may have some features faked for demonstrative purposes. Click here for the fully working system.
These instructions will build the environment to run commands on the project.
- Create
.env
file, based on.env.example
, and set your environment as you wish; npm install
;npm run standalone
(for demonstration only);npm start
(for when you have the WebService and the Socket running);
- The next command will give you a running server. Needing anything specific, change in
docker-compose.yml
; docker-compose build
;docker-compose up
.
The server must be running at [http://localhost:8888/].
- Create a ".env" file base on ".env.example" in the project's root;
- Make sure you have Google Chrome
npm test
.
- Open the
docker-compose.yml
file with your favorite text editor and change thefrontend-web
service command tonpm test
; docker-compose up
.
Clone the project:
git clone https://github.com/jourdanrodrigues/controk-frontend-web
Build the project with docker compose:
docker-compose build
Raise the project:
docker-compose up
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Jourdan Rodrigues - Initial work - Jourdan Rodrigues
See also the list of [contributors][contributors] who participated in this project.