It is highly recommended to use a Unix-based system (such as Ubuntu, Fedora, Kali, or any other) or MacOS. Windows may encounter certain issues with Docker.
- Git is essential before anything else;
- Node and TypeScript;
- If you are on MacOs, you can install above using homebrew;
- Docker
- pnpm
- Prisma
- GPG
- PostGres
To clone the repository, follow these steps:
Open your terminal or command prompt.
Go to the file that you want to download the project (you can use the command ls to see where your location and the comand cd to go to myfiles/exemple).
Then, run the following command to clone the repository:
git clone https://github.com/podcodar/app.git
This command will download the project files to your local machine in the folder app. ✨
To install pnpm on your system, simply run this command if node is installed.
npm install -g pnpm
For other ways to install, follow the official installation instructions for your operating system.
Then use the commands:
pnpm install
to install package.json dependencies
pnpm run
to run the script provided in package.json
We use GPG for credential managing, first make sure you have it installed on your machine and correctly set in your path (if not, follow the requirements doc 😉).
Now install GPG:
brew install gnupgGenerating keys for project
pnpm decryptGPG will ask you the password, to obtain it please contact @frattezi or @marco-souza.
Now, your env files should be populated with the necessary values, cheers! 🥂
To install Docker and Docker Compose on your system, follow the official installation instructions for your operating system.
Docker Installation
Docker Compose Installation
Now you can run the project by typing:
# MacOs users
docker-compose up -d
# Linux users
docker-compose -f docker-compose.yml -f docker-compose.portforward.yml up -d