Skip to content

Commit

Permalink
updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris committed Oct 1, 2023
1 parent 7274500 commit 56233e3
Showing 1 changed file with 5 additions and 18 deletions.
23 changes: 5 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,14 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
Thank you for choosing our multi-container web application template. I hope this setup simplifies the development and deployment of your server and UI components, along with MongoDB as your data store. If you have any questions or need assistance, feel free to reach out. Happy coding!


[Tech Stack](#Tech) |
[Pre-requisites](#prerequisites) |
[Basic commands](#Basic-commands-to-run-the-containers) |
[Database diagram](#Database-diagram)

## Tech
- Docker for creating containers for UI, Server and DB
- React for user interface and visualization
- Go for backend APIs
- Mongo for DB

## Prerequisites
- Docker (LTS)
- NodeJS (LTS)
- MongoDB (LTS)
- Go Compiler (1.19.2)

## Basic commands to run the application
## To setup the containers and run the applications

```sh
sudo docker compose up [--build]
```

## For accessing the applications
```sh
api1 -> http://localhost:4000 [non cors]
api2 -> http://localhost:4545 [cors] [use with web application]
mongo express -> http://localhost:8081
Expand Down

0 comments on commit 56233e3

Please sign in to comment.