Skip to content

Commit

Permalink
Improved readme again
Browse files Browse the repository at this point in the history
  • Loading branch information
nsearls-bu committed Mar 25, 2024
1 parent 430e2e0 commit fd58723
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,31 @@
# ec530-project-2
Repository for hosting project 2 for BU EC530 of NLP analyser project

# BU EC530 NLP Analyzer Project 2

Contains the stub builds of APIS to connect to a postgres database.
Run compose file with docker compose up -d after building to start API backend.
Welcome to the repository for Project 2 of BU EC530's NLP Analyzer project! This repository contains the stub builds of APIs designed to connect to a PostgreSQL database. Follow the instructions below to set up the API backend using Docker Compose.

Docker images are stored in my docker repository nedsearls/ec530-bu
Run docker logs project2-test-1 to view output of log file.
## Instructions

![alt text](Screenshot 2024-03-24 at 8.05.06 PM.png)
**Clone the Repository**:

```bash
git clone https://github.com/yourusername/ec530-project2.git
cd ec530-project2
```

**Build and Run with Docker Compose**: After navigating into the project directory, use Docker Compose to build and start the API backend.

```bash
docker-compose up -d --build
```

**View Logs**: To view the output of the log file, use the following command:

```bash
docker logs project2-test-1
```

4. **Accessing Docker Images**: Docker images for this project are stored in the Docker repository `nedsearls/ec530-bu`. You can access them using Docker commands as needed.

## Screenshots

![Screenshot](Screenshot.png)

0 comments on commit fd58723

Please sign in to comment.