Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with Docker setup instructions and clean up init-db script #190

Merged
merged 3 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 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
mayura-andrew marked this conversation as resolved.
Show resolved Hide resolved
-------------------------------------

You can also run the ScholaX backend using Docker. Follow these setps:
mayura-andrew marked this conversation as resolved.
Show resolved Hide resolved

1. Ensure you have Docker and Docker Compose installed on you machine.

2. Build and run the Docker constainers.
mayura-andrew marked this conversation as resolved.
Show resolved Hide resolved

```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 Expand Up @@ -229,6 +249,8 @@ We appreciate your interest in ScholarX. Happy contributing! If you have any que

8. Verify it from your account.



Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

## Project Structure

Here's an overview of the project structure:
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