diff --git a/README.md b/README.md index b410ad58..42e63747 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@

CMPE352/451 Group 1
Disaster Response Platform

+## Software +You can find the alpha version of our software in the `resq` subdirectory + *** ## ⛑ About Us diff --git a/resq/README.md b/resq/README.md new file mode 100644 index 00000000..f3d99975 --- /dev/null +++ b/resq/README.md @@ -0,0 +1,48 @@ +# ResQ + +ResQ is REST based web service for the Disaster Response Application ResQ developed by CMPE451-GroupA1 + +## Getting Started + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. + +### Prerequisites + +- Docker and Docker-Compose + +### Config Directory Structure + +The backend application gets the actual path from `resq.appdir` property and checks for **resq** directory under that path. + +Under main directory structure is: +- **conf** + - **appparam.txt**: application configuration items are located under this file (web service url, username and pass etc.) + - **logConf.xml**: log configuration file. +- **log**: Application writes all logs under this directory + +### Installing with Docker + +First clone all files into local repo. + +Place the config folder named as project_env under the directory bounswe2023group1\resq\backend\resq. +Then, run the following commands: + +docker-compose up + +## Project Specific Information + +The local buld of the frontend application is available on http://localhost:3000 + +Production frontend URL: https://resq.org.tr + + +Backend application context root is /resq/api/v1/. You can reach the backend application via +https://localhost:8081/resq/api/v1/. +To reach the API documentation: +https://localhost:8081/resq/api/v1/swagger-ui.html + + +Production backend URL: https://api.resq.org.tr/resq/api/v1 + +Production backend API Documentation: +https://api.resq.org.tr/resq/api/v1/swagger-ui/index.html \ No newline at end of file diff --git a/resq/backend/resq/docker-compose.yml b/resq/backend/resq/docker-compose.yml index 42c4d465..3378cda5 100644 --- a/resq/backend/resq/docker-compose.yml +++ b/resq/backend/resq/docker-compose.yml @@ -29,6 +29,16 @@ services: - POSTGRES_PASSWORD=compose-postgres networks: - app_network + + frontend: + container_name: frontend + image: frontend:latest + build: + context: ../../frontend + ports: + - "3000:3000" + expose: + - "3000" networks: app_network: diff --git a/resq/frontend/Dockerfile b/resq/frontend/Dockerfile new file mode 100644 index 00000000..eca7b43e --- /dev/null +++ b/resq/frontend/Dockerfile @@ -0,0 +1,11 @@ +FROM node:18-alpine + +WORKDIR /react/ + +COPY ./public/ /react/public +COPY ./src/ /react/src +COPY package.json /react/ + +RUN npm install + +ENTRYPOINT npm start