diff --git a/README.md b/README.md index d095ca3..4efc102 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 (optional) +------------------------------------- + +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 containers. + +```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 ------------------------------------- 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."