- What is this project?
- How does it work?
- Who will use this project?
- What is the goal of this project?
This application allow timber harvesters to report their harvested quantity through an online application which can then be approved through the internal Forestar Apex Application
###Directory Structure
The project contains three modules:
/client
Front-end application written in React/server
Back-end API in a ExpressJS sever/_docker
Docker specific files for docker-compose
###Environment Variables
Each module has their own .env
file as needed. .env.base
files give an idea of the required variables.
###Development
To run the application in a development environment. Checkout the repo and create .env files with appropriate values for the dev setup.
nginx
At the root level rundocker-compose up
/client
In this directory runnpm i
and thennpm start
. For Windows,npm start-win
/server
In this directory runnpm i
and thennpm run start-watch
. For Windows,npm start-watch-win
###Test
To build and run a test environment. Checkout the repo and create .env
files with appropriate values for the test setup.
####To build client image
- In the
/client
directory run:npm i
npm run build-css
nom run build
docker build -t timber-client .
####To build server image
- In the
/server
directory run:npm i
nom run build
docker build -t timber-api .
####To run images and nginx in front of them
At the root level run docker-compose -f docker-compose-test.yml up