Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
magarciam2003 authored Apr 28, 2024
1 parent 4ea451a commit d8d7820
Showing 1 changed file with 18 additions and 194 deletions.
212 changes: 18 additions & 194 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -816,35 +816,29 @@ To compile and run the SPA , follow these steps to set up your development envir
```
- You should see the installed version of Angular CLI.
4. **Clone and navigate to the project directory:**
4. **Clone this repository:**
- Clone the repository.
```
git clone https://github.com/CodeURJC-DAW-2023-24/webapp07
```
- Navigate to the project directory in the terminal.
```
cd frontend
```
5. **Install dependencies:**
- Execute the following command to install the project dependencies:
```
npm install
```
5. **In order to execute the application, you will need to [install docker](https://www.docker.com/get-started/)**
6. **Compile the application:**
- Once all dependencies are installed, you can compile the application using the following command:
```
ng build
```
- This will compile the application and generate static files in the `dist/` directory.
6. **Then, run docker.**
7. **Run the application:**
- After compiling the application, you can run it locally using the built-in development server of Angular CLI. Execute the following command:
```
ng serve
```
- This will start the development server, and the application will be available at `http://localhost:4200/`.
7. **Finally, open a git bash (Use git bash in case that you're using windows, the terminal will do the work in linux) in the folder where you cloned the repository.**
8. **Then change directory:**
```shell
cd docker/
```
9. **Then execute the following command:**
```shell
docker-compose up -d
```
10. **Lasltly, open https://localhost:8443/new**
<h2>
📊 Diagram
Expand All @@ -854,178 +848,6 @@ To compile and run the SPA , follow these steps to set up your development envir
<img alt="screenshot" src="https://github.com/CodeURJC-DAW-2023-24/webapp07/assets/123759990/4c1df864-c3a6-4ca6-881c-aba2e3ea2157">
</p>
<h2>
🔧 Execution instructions for the dockerized app
</h2>
1.- In order to execute the application, you will need to [install docker](https://www.docker.com/get-started/)
2.- Then, you will have to clone this repository:
```shell
git clone https://github.com/CodeURJC-DAW-2023-24/webapp07
```
3.- Then, run docker.
4.- Finally, open a git bash (Use git bash in case that you're using windows, the terminal will do the work in linux) in the folder where you cloned the repository.
5.- Then change directory:
```shell
cd docker/
```
6.- Then execute the following command:
```shell
docker-compose up -d
```
5.- Lasltly, open https://localhost:8443/new
<h2>
⚙️ Intructions to deploy the app in the Virtual Machine
</h2>
1.- In order to access the VM, you have to be either connected to eduroam or to the URJC's VPN.
To access the VPN, you must download the [paloalto VPN](https://vpn.urjc.es/global-protect/getsoftwarepage.esp).
Then connect to vpn.urjc.es
2.- Once you are connected, you have to download the .key file. You'll perhaps have to change the key's permissions:
If you're using linux, executing chmod 600 will be enough. In case you're using windows, you'll have to set your user as the owner of the .key file.
3.- Then, you have to open a git bash in the key's directory and write the following command
```shell
ssh -i prAppWeb07.key [email protected]
```
4.- Then, you will have to clone this repository:
```shell
git clone https://github.com/CodeURJC-DAW-2023-24/webapp07
```
5.- And execute the followiing command to change to the app's directory:
```shell
cd webapp07/docker
```
6.- Finally, deploy the app:
```shell
docker-compose up -d
```
<h2>
🛠️ Docker Image Construction
</h2>
For building and publishing the docker image follow these steps:
1.- Install docker if not installed
2.- Run docker
3.- Clone application repository:
```shell
git clone https://github.com/CodeURJC-DAW-2023-24/webapp07
```
4.- Move to de docker directory:
```shell
cd webapp07/docker
```
5.- Give respective permissions:
```shell
chmod +x create_image.sh
```
6.- Execute the script:
```shell
./create_image.sh
```
<h2>
🐳 Docker Image
</h2>
You can access the docker image of our app at Dockerhub at this link:
https://hub.docker.com/r/rphydra/seedventures
This image contains the latest stable version, ready for deployment.
<h2>
📡 Virtual Machine Application URL and Example Users
</h2>
The application can be accessed at the following URL: https://10.100.139.153:8443/new
<h3>
👤 Example Users
</h3>
**Admin**
- username: admin
- password: 1234
**User1**
- username: User1
- password: 1234
**User2**
- username: User2
- password: 1234
**User3**
- username: User3
- password: 1234
**User4**
- username: User4
- password: 1234
**MarkiIndustries**
- username: MarkiIndustries
- password: 1234
**EcoWorld**
- username: EcoWorld
- password: 1234
**proglearn**
- username: proglearn
- password: 1234
**Trustbusiness**
- username: Trustbusiness
- password: 1234
**Bewater**
- username: Bewater
- password: 1234
**MortezLab**
- username: MortezLab
- password: 1234
**PixelStudios**
- username: PixelStudios
- password: 1234
**MindCare**
- username: MindCare
- password: 1234
**LingoTech**
- username: LingoTech
- password: 1234
**GreenHarbor**
- username: Trustbusiness
- password: 1234
**CosmicTech**
- username: CosmicTech
- password: 1234
<h2>
👥 Participation
</h2>
Expand Down Expand Up @@ -1170,3 +992,5 @@ The application can be accessed at the following URL: https://10.100.139.153:844
<h2>
🎬 Video
</h2>
[Seedventures Demo | Youtube](https://www.youtube.com/watch?v=Ye9ADFgeuIE)

0 comments on commit d8d7820

Please sign in to comment.