The user interface to StockStalker

StockStalker - Frontend

Table of Contents

• Make Commands
• Required Software
• How to Run

Make Commands

stop: Stop the running server

rm: Remove all unused containers

rm-all: Stop and remove all containers

rmi: Remove stockstalker images without removing base images. Useful for speeding up build time when switching from one start script to another such as make start to make test

rmi-all: Remove all images

purge: Use with caution Completely purge Docker containers, networks, images, volumes, and cache

lint: Run prettier and eslint

build: Build development server without running the server

start: Start development server at port 8080

reload: Stop development server and restart the server at port 8080

hard-reload: Stop container, remove container, rebuild container, and start development server

debug: Start development server in debug mode

stop-build: Start build server at port 8080

start-build: Stop build server

test-security: Test security vulnerabilities (must have snyk installed globally)

test-image-security: Test security vulnerabilities for base images (must have snyk installed globally)

Required Software

• Docker
• docker-comopse
• CMake

How to Run

Clone the repo

git clone git@github.com:Stock-Stalker/frontend.git

cd into the directory

cd frontend

Rename .env.sample to .env

mv .env.sample .env

Edit the .env file to contain your environment variables

vim .env

Run the application!

make start

To stop the app press CNTRL + C. Then run:

make stop