Welcome to the deploy repository, a comprehensive solution featuring separate frontend and backend components. This repository uses Git submodules to manage the relationship between the different parts of the project efficiently.

Before you begin, ensure you have met the following requirements:

• Docker: You will need Docker to run the containers for the database and the application. Download it from Docker's website.
• Ports: Make sure you have port 8080 (API), 8085 (Go/Export), 8082 (Java/Encryption) and 5432 (POSTGRESQL) not used by another resource
• No, you don't need Java or Maven! You just have to run the script correctly.

To clone this project along with its submodules, you need to run the following command:

git clone --recurse-submodules https://github.com/VaultShield/app.git

This command clones the main repository and initializes and updates each submodule in the repository.

After cloning the repository, ensure all submodules are fully updated and in the correct state:

git submodule update --init --recursive --remote

The default is to use master, but if you need to deploy another branch, access the branch and make a git switch to the branch you need

You will need to create a .env following the specifications of the .env.example

example:

JWT_SECRET=EXAMPLE_64_CHARACTERS
JWT_RECOVER=EXAMPLE_64_CHARACTERS
POSTGRES_PASSWORD=EXAMPLE_20_CHARACTERS

and you need add a .env.local in frontend

example:

VITE_SECRET_KEY=PASS
VITE_BASE_URL=http://localhost:8080/
VITE_REGISTER_URL=api/auth/register
VITE_LOGIN_URL=api/auth/login
VITE_REFRESH_TOKEN_URL=api/auth/refreshtoken
VITE_RECOVER_URL=api/auth/recover
VITE_USER_URL=api/user/
VITE_SEARCH_USER_URL=api/user/search
VITE_CREDENTIAL_URL=api/credential/
VITE_ADD_CREDENTIAL_URL=api/credential/insert
VITE_FINDALL_CREDENTIAL_URL=api/credential/find-all/

Fill in the necessary data and save it in a file called ".env" and ".env.local"

for windows:

.\start.ps1

for MacOs or Linux users

chmod +x start.sh
./start.sh

And you get it!!

You can use the latest submodule update available with the develop's branches:

# Navigate to the submodule directory
cd backend #example

# Pull the latest changes
git pull origin develop # develop is the latest develop branch updated, but it may not be stable

# Go back to the main project directory
cd ../..

# Start the proyect
./start.sh

To update the submodules to the latest commits available from their respective upstream branches, use the following commands:

# Navigate to the submodule directory
cd frontend #example

# Pull the latest changes
git pull origin develop # develop is the latest develop branch updated, but it may not be stable

# Go back to the main project directory
cd ../..

# Add the submodule changes
git add frontend

# Commit and push the submodule updates
git commit -m "Updated submodule to latest version"
git push

or...

git submodule update --init --recursive --remote

This project is licensed under the MIT License, and the submodules too.