Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
unizhu committed Aug 12, 2024
1 parent d6e913a commit 07cf01e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ This repo is a web-based application built with Flask for the backend and React
- [Backend (Flask)](#backend-flask)
- [Frontend (Optional) For Development](#frontend-optional-for-development)
- [Usage](#usage)
- [Use Docker](#use-docker)
- [Logging In](#logging-in)
- [Generating ER Diagrams](#generating-er-diagrams)
- [Screenshot](#screenshot)
Expand Down Expand Up @@ -101,6 +102,21 @@ Access the application in your web browser by navigating to:
http://localhost:8082
```

### Use Docker

1. Pull & Run the Docker Image:

```bash
docker pull unizhu/salesforce-erd-generator
docker run -p 8082:8082 unizhu/salesforce-erd-generator
```

2. Access the application in your web browser by navigating to:

```bash
http://localhost:8082
```

### Logging In

- Select your Salesforce environment (Production, Sandbox, Custom).
Expand All @@ -122,6 +138,7 @@ Access the application in your web browser by navigating to:

- [ ] Add support for oAuth Login.
- [ ] Automatically re-generate ERD when fields limit is changed.
- [ ] Fix Add Custom Object/Field with undo/redo bugs.

## License

Expand Down
Binary file modified frontend/public/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 07cf01e

Please sign in to comment.