We are using the PERN stack (Postgres, Node/Express, React, Nginx). These scripts work best in a unix environment running docker and node. It is recommended that you also have Postgres installed on your machine, but this is not necessary as you can spin up a docker postgres container in the db folder.
Note: the following scripts are to be executed from the top level folder.
Execute just the backend using sh script/run_backend.sh
Use an nginx docker image to run a small webserver locally:
cd html; sh run.sh
Run postgres alone using docker: cd db; docker-compose up. You can kill this by using docker-compose down in the same folder.
To run everything together the first time, execute docker-compose up --build. Every other time you can use docker-compose up.
Run the backend tests by executing sh script/run_tests.sh.
Compile the documentation by executing cd docs; sh run.sh; Serve the docs locally using sh serve.sh.
.
├── db
│ ├── data
├── docs
│ └── assets
└── srcThe src folder contains all of the ts-node files.
src/
├── middleware
├── models
├── routes
│ └── word
├── services
│ ├── firebase
│ ├── postgres
│ └── selenium
├── tests
│ ├── lesson
│ └── word
├── types
└── utilsAn image depicting the technologies used in this project.
An image depicting the relationships to other projects within the Quran Journey development scope.
Entity Relationship Diagram for this application and other microservices