🛠ī¸Getting set up

In this guide we will teach you how to build our project step by step.

  1. Prerequisites that we will have to have installed, here we will leave you a series of guides so that you can install it.

-Visual Studio-
https://code.visualstudio.com/docs/setup/windows
-Git-
https://phoenixnap.com/kb/how-to-install-git-windows
-Nodejs-
https://radixweb.com/blog/installing-npm-and-nodejs-on-windows-and-mac
-Golang-
https://go.dev/doc/install
-Docker-
https://docs.docker.com/desktop/install/windows-install/
-Make-
https://stackoverflow.com/a/32127632

  1. We will create our Hello folder in which we will store our frontend and backend.

  1. Next we will open our visual studio, in the upper left part we will click on file and we will open the folder created previously.

  1. We will open the terminal located at the top of visual studio.

  1. A terminal will open at the bottom and we will put the following commands to be able to download from our public git repository

  • This would be our backend:

git clone https://github.com/Hello-Storage/hello-back.git

  • This would be our frontend:

git clone https://github.com/Hello-Storage/hello-front.git

  • Once the execution of these commands is finished, the 2 folders corresponding to the project will have been generated.

  1. We will stay in the terminal to proceed to put the following commands, which will be to create the volumes that will contain the postgres database.

docker volume create postgres-data

  1. We will make a copy of the .env.example and rename it as .env, in the terminal we will write the following, we must do this both in the fronted and in the backend

copy .env.example .env

  1. In the .env of the back that we have created we must put the environment variables.

  • "adjust your variables"

# Hello Storage Envs

APP_PORT=
APP_ENV=

# token
TOKEN_SYMMETRIC_KEY=
ACCESS_TOKEN_DURATION=
REFRESH_TOKEN_DURATION=

# Postgres
POSTGRES_HOST=
POSTGRES_DB=
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_PORT=

POSTGRES_MOCK_HOST=
POSTGRES_MOCK_DB=
POSTGRES_MOCK_USER=
POSTGRES_MOCK_PASSWORD=
POSTGRES_MOCK_PORT=

# FileBase Credential
FILEBASE_ACCESS_KEY=
FILEBASE_SECRET_KEY=
FILEBASE_PINNING_KEY=

  1. And in the .env of the front we will put:

  • "adjust your variables"

VITE_API_ENDPOINT=
VITE_GOOGLE_CLIENT_ID=
VITE_GOOGLE_CLIENT_SECRET=
VITE_GITHUB_CLIENT_ID=
VITE_GITHUB_CLIENT_SECRET=
VITE_GITHUB_REDIRECT_URL=

  1. We will raise the backend

make production

  1. Before we can launch the frontend we must install npm in order to have the necessary packages

npm install

  1. We will execute yarn to download all the required packages

yarn

  1. Finally we will execute the command to raise the frontend

yarn dev
PreviousIPFS GatewayNextDictionary

Last updated