Skip to content

Commit

Permalink
Update README with Docker setup instructions and clean up init-db scr…
Browse files Browse the repository at this point in the history
…ipt (#190)
  • Loading branch information
mayura-andrew authored Dec 2, 2024
1 parent bbeec76 commit d84047b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------

Expand Down
1 change: 0 additions & 1 deletion init-db.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down

0 comments on commit d84047b

Please sign in to comment.