From 29ae1ed0181fb893000c637b2e297ae387868b64 Mon Sep 17 00:00:00 2001 From: Bere333 Date: Thu, 5 May 2022 19:41:44 -0500 Subject: [PATCH 1/6] add translations files --- translations/README-es.md | 62 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 translations/README-es.md diff --git a/translations/README-es.md b/translations/README-es.md new file mode 100644 index 00000000..793e27c7 --- /dev/null +++ b/translations/README-es.md @@ -0,0 +1,62 @@ +# Treejer Protocol Smart Contracts + +![Background Image](./assets/treejerStory.png) +[![Twitter Follow](https://img.shields.io/twitter/follow/TreejerTalks?label=Follow)](https://twitter.com/TreejerTalks) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![CircleCI](https://circleci.com/gh/treejer/contract/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/treejer/contract?branch=main&filter=all) +[![Coverage Status](https://coveralls.io/repos/github/treejer/contract/badge.svg?branch=main)](https://coveralls.io/github/treejer/contract?branch=main) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://docs.treejer.com/project-charter#da-contributor-covenant-code-of-conduct) + +Treejer Protocol Smart Contracts es una implementación ligera de [Treejer Protocol](treejer.com) en Polygon. + + +La documentación completa del protocolo de Treejer y las ligas a los últimos lanzamientos de contratos se encuentran disponibles en [Treejer Docs](https://docs.treejer.com/smart-contracts). + +Visite [Treejer Blog](http://blog.treejer.com) para más detalles sobre Treejer y como funciona. + + +## Local Development + +Los siguientes pasos asumen el uso de `node@>=13`. + +### Instalación de Dependencias + +`npm install` + +### Start Ganache + +`npm run ganache` + +### Test + +`npm run test` + +### Deploy on local ganache + +`npm run deploy` + +### Desarrollo con el uso de Docker + +In order to facilitate better development and testing, the project has been integrated with [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/). This eliminates the necessity to setup the environment in your local machine. Simply spin up the `container` and start developing and testing in it. +Con el propósito de facilitar el mejor desarrollo y testing, el proyecto ha sido integrado con [Docker](https://www.docker.com/) y [Docker Compose](https://docs.docker.com/compose/). + +**Requerimentos** +- `Docker` - Si no tienes Docker instalado localmente, puedes seguir los siguientes pasos [here](https://docs.docker.com/get-docker/). Esto. además, puede instalar `docker-compose`. + +**Configuración** + +Two modes can be enabled via docker: +- _Development_: This creates a `container` with the project and all the dependencies installed in it. The project location in your local machine will be linked as a [volume](https://docs.docker.com/storage/volumes/) to the container and any edits you make in your local would be synced to the container. To spin up the development container use: `docker-compose up develop` +- _Testing_: This brings up a container and runs all the tests in it automatically and can be used purely for testing purposes. To spin up a testing container use: `docker-compose up test` + +Dos modos en que se puede adaptar vía docker: +- _Development_: This creates a `container` with the project and all the dependencies installed in it. The project location in your local machine will be linked as a [volume](https://docs.docker.com/storage/volumes/) to the container and any edits you make in your local would be synced to the container. To spin up the development container use: `docker-compose up develop` +- _Testing_: This brings up a container and runs all the tests in it automatically and can be used purely for testing purposes. To spin up a testing container use: `docker-compose up test` + +## How to Contribute + +To chat with us & stay up to date, join our [Discord](https://discord.gg/8WuVd2ERC2). + +Vulnerabilities should be disclosed directly to the Treejer team by emailing security@treejer.com. + +_© Copyright 2021, Treejer_ \ No newline at end of file From 3690d2d6544973e1f096fd25dd03e0343d2e6c02 Mon Sep 17 00:00:00 2001 From: Bere333 Date: Thu, 5 May 2022 22:04:44 -0500 Subject: [PATCH 2/6] complete translation --- README.md | 2 ++ translations/README-es.md | 20 ++++++++------------ 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 28105cdb..83d50c96 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,5 @@ To chat with us & stay up to date, join our [Discord](https://discord.gg/8WuVd2E Vulnerabilities should be disclosed directly to the Treejer team by emailing security@treejer.com. _© Copyright 2021, Treejer_ + +[Spanish version](./translations/README-es.md) diff --git a/translations/README-es.md b/translations/README-es.md index 793e27c7..dfa174ee 100644 --- a/translations/README-es.md +++ b/translations/README-es.md @@ -1,6 +1,6 @@ # Treejer Protocol Smart Contracts -![Background Image](./assets/treejerStory.png) +![Background Image](../assets/treejerStory.png) [![Twitter Follow](https://img.shields.io/twitter/follow/TreejerTalks?label=Follow)](https://twitter.com/TreejerTalks) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![CircleCI](https://circleci.com/gh/treejer/contract/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/treejer/contract?branch=main&filter=all) @@ -37,26 +37,22 @@ Los siguientes pasos asumen el uso de `node@>=13`. ### Desarrollo con el uso de Docker -In order to facilitate better development and testing, the project has been integrated with [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/). This eliminates the necessity to setup the environment in your local machine. Simply spin up the `container` and start developing and testing in it. -Con el propósito de facilitar el mejor desarrollo y testing, el proyecto ha sido integrado con [Docker](https://www.docker.com/) y [Docker Compose](https://docs.docker.com/compose/). +Con el propósito de facilitar el mejor desarrollo y testeo, el proyecto ha sido integrado con [Docker](https://www.docker.com/) y [Docker Compose](https://docs.docker.com/compose/). Esto elimina lo necesario para configurar el ambiente de desarrollo en tu máquina local. Simplemente corre el `container` y empieza a desarrollar y testear en él. **Requerimentos** -- `Docker` - Si no tienes Docker instalado localmente, puedes seguir los siguientes pasos [here](https://docs.docker.com/get-docker/). Esto. además, puede instalar `docker-compose`. +- `Docker` - Si no tienes Docker instalado localmente, puedes seguir los siguientes pasos [here](https://docs.docker.com/get-docker/). Esto, además, puede instalar `docker-compose`. **Configuración** -Two modes can be enabled via docker: -- _Development_: This creates a `container` with the project and all the dependencies installed in it. The project location in your local machine will be linked as a [volume](https://docs.docker.com/storage/volumes/) to the container and any edits you make in your local would be synced to the container. To spin up the development container use: `docker-compose up develop` -- _Testing_: This brings up a container and runs all the tests in it automatically and can be used purely for testing purposes. To spin up a testing container use: `docker-compose up test` - Dos modos en que se puede adaptar vía docker: -- _Development_: This creates a `container` with the project and all the dependencies installed in it. The project location in your local machine will be linked as a [volume](https://docs.docker.com/storage/volumes/) to the container and any edits you make in your local would be synced to the container. To spin up the development container use: `docker-compose up develop` -- _Testing_: This brings up a container and runs all the tests in it automatically and can be used purely for testing purposes. To spin up a testing container use: `docker-compose up test` +- _Development_: Esto crea un `container` con el proyecto y todas las dependencias son intaladas en esto. La localización del proyecto en tu maquina local estará linkeada como un [volume](https://docs.docker.com/storage/volumes/) para el contenedor y cualquier edición local deberá sincronizarse con el contenedor. Para correr (spin up) el contenedor de desarrollo usa: `docker-compose up develop` +- _Testing_: Esto proporciona un contenedor y corre todos los tests automáticamente y puede ser usado puramente para propósitos de testeo. Para correr un contenedor de testeo usar: `docker-compose up test` -## How to Contribute +## Cómo contribuir To chat with us & stay up to date, join our [Discord](https://discord.gg/8WuVd2ERC2). +Para chatear con nosotros y mantenerse actualizado, unírsenos a [Discord](https://discord.gg/8WuVd2ERC2). -Vulnerabilities should be disclosed directly to the Treejer team by emailing security@treejer.com. +Vulnerabilidades deberían ser notificadas al equipo de Treejer por correo electrónico security@treejer.com. _© Copyright 2021, Treejer_ \ No newline at end of file From cff7367dd9b728eb2fa40aa68cc10b51381d9920 Mon Sep 17 00:00:00 2001 From: Bere333 Date: Fri, 6 May 2022 08:26:23 -0500 Subject: [PATCH 3/6] add americans emoji --- README.md | 5 ++++- translations/README-es.md | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83d50c96..291da2ef 100644 --- a/README.md +++ b/README.md @@ -54,4 +54,7 @@ Vulnerabilities should be disclosed directly to the Treejer team by emailing sec _© Copyright 2021, Treejer_ -[Spanish version](./translations/README-es.md) +### Translations :earth_americas: + +- [Spanish version](./translations/README-es.md) +- [Portuguese version](./translations/README-pt.md) diff --git a/translations/README-es.md b/translations/README-es.md index dfa174ee..98c0c8c4 100644 --- a/translations/README-es.md +++ b/translations/README-es.md @@ -31,7 +31,7 @@ Los siguientes pasos asumen el uso de `node@>=13`. `npm run test` -### Deploy on local ganache +### Deploy en local ganache `npm run deploy` From bbec0d01f3ec897a3a58647a2f166c577caa5433 Mon Sep 17 00:00:00 2001 From: Bere333 Date: Fri, 6 May 2022 08:29:17 -0500 Subject: [PATCH 4/6] fixed contribute line --- translations/README-es.md | 1 - 1 file changed, 1 deletion(-) diff --git a/translations/README-es.md b/translations/README-es.md index 98c0c8c4..7f484f85 100644 --- a/translations/README-es.md +++ b/translations/README-es.md @@ -50,7 +50,6 @@ Dos modos en que se puede adaptar vía docker: ## Cómo contribuir -To chat with us & stay up to date, join our [Discord](https://discord.gg/8WuVd2ERC2). Para chatear con nosotros y mantenerse actualizado, unírsenos a [Discord](https://discord.gg/8WuVd2ERC2). Vulnerabilidades deberían ser notificadas al equipo de Treejer por correo electrónico security@treejer.com. From 5774779582d5e229a3510e423dff9037718c9507 Mon Sep 17 00:00:00 2001 From: marya277 Date: Fri, 6 May 2022 12:59:25 -0500 Subject: [PATCH 5/6] readme portugues --- translations/README.pt_BR.md | 46 ++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 translations/README.pt_BR.md diff --git a/translations/README.pt_BR.md b/translations/README.pt_BR.md new file mode 100644 index 00000000..76e593ab --- /dev/null +++ b/translations/README.pt_BR.md @@ -0,0 +1,46 @@ +Os contratos inteligentes do protocolo Treejer são uma implementação leve do [Protocolo Treejer](treejer.com) no Polygon. + +Documentação detalhada sobre o protocolo Treejer e os endereços de contratos implantados mais recentes estão disponíveis em [Treejer Docs](https://docs.treejer.com/smart-contracts). + +Visite [Treejer Blog](http://blog.treejer.com) para obter mais detalhes sobre o Treejer e como ele funciona. + +## Desenvolvimento Local + +O seguinte assume o uso de `node@>=13`. + +### Instalar dependências + +`npm instalar` + +### Iniciar Ganache + +`npm executar ganache` + +### Teste + +`npm executar teste` + +### Implante no ganache local + +`npm executar implantação` + +### Desenvolvimento usando Docker + +Para facilitar o melhor desenvolvimento e teste, o projeto foi integrado ao [Docker](https://www.docker.com/) e ao [Docker Compose](https://docs.docker.com/compose/). Isso elimina a necessidade de configurar o ambiente em sua máquina local. Simplesmente gire o `container` e comece a desenvolver e testar nele. + +**Requisitos** +- `Docker` - Se você não tiver o Docker instalado em sua máquina local, você pode obtê-lo seguindo as etapas [aqui](https://docs.docker.com/get-docker/). Isso também deve instalar o `docker-compose`. + +**Configuração** + +Dois modos podem ser ativados via docker: +- _Desenvolvimento_: Cria um `container` com o projeto e todas as dependências instaladas nele. O local do projeto em sua máquina local será vinculado como um [volume](https://docs.docker.com/storage/volumes/) ao contêiner e todas as edições feitas em seu local serão sincronizadas com o contêiner. Para ativar o contêiner de desenvolvimento, use: `docker-compose up develop` +- _Testing_: Isso abre um contêiner e executa todos os testes nele automaticamente e pode ser usado apenas para fins de teste. Para ativar um contêiner de teste, use: `docker-compose up test` + +## Como contribuir + +Para conversar conosco e manter-se atualizado, junte-se ao nosso [Discord](https://discord.gg/8WuVd2ERC2). + +As vulnerabilidades devem ser divulgadas diretamente à equipe Treejer enviando um e-mail para security@treejer.com. + +_© Copyright 2021, Treejer_ \ No newline at end of file From 33c7020f8186011e9cb611caebeac1f60a5ce974 Mon Sep 17 00:00:00 2001 From: Bere333 Date: Fri, 6 May 2022 13:17:35 -0500 Subject: [PATCH 6/6] changed name portuguese file --- README.md | 2 +- translations/{README.pt_BR.md => README-pt-br.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename translations/{README.pt_BR.md => README-pt-br.md} (100%) diff --git a/README.md b/README.md index 291da2ef..675bbac4 100644 --- a/README.md +++ b/README.md @@ -57,4 +57,4 @@ _© Copyright 2021, Treejer_ ### Translations :earth_americas: - [Spanish version](./translations/README-es.md) -- [Portuguese version](./translations/README-pt.md) +- [Portuguese version](./translations/README-pt-br.md) diff --git a/translations/README.pt_BR.md b/translations/README-pt-br.md similarity index 100% rename from translations/README.pt_BR.md rename to translations/README-pt-br.md