diff --git a/README.md b/README.md index 28105cdb..675bbac4 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,8 @@ 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_ + +### Translations :earth_americas: + +- [Spanish version](./translations/README-es.md) +- [Portuguese version](./translations/README-pt-br.md) diff --git a/translations/README-es.md b/translations/README-es.md new file mode 100644 index 00000000..7f484f85 --- /dev/null +++ b/translations/README-es.md @@ -0,0 +1,57 @@ +# 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 en local ganache + +`npm run deploy` + +### Desarrollo con el uso de Docker + +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`. + +**Configuración** + +Dos modos en que se puede adaptar vía docker: +- _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` + +## Cómo contribuir + +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. + +_© Copyright 2021, Treejer_ \ No newline at end of file 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