From 634a324ba4a7c83cd917033798d85f26ad06f570 Mon Sep 17 00:00:00 2001 From: mayura-andrew Date: Sun, 1 Dec 2024 17:35:33 +0530 Subject: [PATCH 1/3] Update README with Docker setup instructions and clean up init-db script --- README.md | 22 ++++++++++++++++++++++ init-db.sh | 1 - 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d095ca3..539c4bf 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,26 @@ Follow these steps to get started with the ScholarX backend: 7. Open your web browser and navigate to `http://localhost:${server_port}` to access the running server. +Docker Setup +------------------------------------- + +You can also run the ScholaX backend using Docker. Follow these setps: + +1. Ensure you have Docker and Docker Compose installed on you machine. + +2. Build and run the Docker constainers. + +```bash +docker compose up --build +``` +3. The application will be available at `http://localhost:${server_port}`. + +4. To stop the containers, run: + +```bash +docker compose down +``` + Database Configuration and Migrations ------------------------------------- @@ -229,6 +249,8 @@ We appreciate your interest in ScholarX. Happy contributing! If you have any que 8. Verify it from your account. + + ## Project Structure Here's an overview of the project structure: diff --git a/init-db.sh b/init-db.sh index d61afdf..a703458 100755 --- a/init-db.sh +++ b/init-db.sh @@ -6,7 +6,6 @@ echo "Database is ready. Running migrations..." # Run the migrations npm run sync:db -npm run migration:generate npm run seed echo "Migrations complete. Database is ready." From b36f4f8e97fab631e11a35caeeac659ef46f4f60 Mon Sep 17 00:00:00 2001 From: mayura-andrew Date: Sun, 1 Dec 2024 20:01:37 +0530 Subject: [PATCH 2/3] Remove unnecessary blank lines from README --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 539c4bf..7b1b10a 100644 --- a/README.md +++ b/README.md @@ -249,8 +249,6 @@ We appreciate your interest in ScholarX. Happy contributing! If you have any que 8. Verify it from your account. - - ## Project Structure Here's an overview of the project structure: From 7ab1ee6f6d4cb866056e20cd940fe9d41aa79b3b Mon Sep 17 00:00:00 2001 From: mayura-andrew Date: Mon, 2 Dec 2024 10:36:09 +0530 Subject: [PATCH 3/3] Clarify Docker setup instructions in README and fix typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7b1b10a..4efc102 100644 --- a/README.md +++ b/README.md @@ -62,14 +62,14 @@ Follow these steps to get started with the ScholarX backend: 7. Open your web browser and navigate to `http://localhost:${server_port}` to access the running server. -Docker Setup +Docker Setup (optional) ------------------------------------- -You can also run the ScholaX backend using Docker. Follow these setps: +Alternatively you can use Docker to run ScholarX. Follow these setps: 1. Ensure you have Docker and Docker Compose installed on you machine. -2. Build and run the Docker constainers. +2. Build and run the Docker containers. ```bash docker compose up --build