README.md

FT_TRANSCENDENCE

English

Content in PT-BR

Content

• About
• Tools
• How to use
• Contributors

About

The project its about recreate the famous pong game, using new tools, such as React.

Tools

• As develop language, TypeSript was used.
• The back-end was develop with NestJs, a framework of typescript with severals tools that helped developing the project.
• The front-end was develop with React with typescript, one of the most used frameworks on web developing.

How to use

• If you want to test in your machine you will need to do some configurations to have a complete use of the application.

ENVS

    ./web/.env

    VITE_API_HOST={Your api host}
    VITE_API_PORT={Your api Port}
    VITE_REDIRECT_LOGIN_URL={Intra redirect url to authentication}
    VITE_GAME_NAMESPACE="game"
    VITE_CHAT_NAMESPACE="chat"
    VITE_STATUS_NAMESPACE="status"

    ./.production.env

    ACCESS_TOKEN_URI="https://api.intra.42.fr/oauth/token"
    CLIENT_ID_INTRA={Intra client id}
    CLIENT_SECRET_INTRA={Intra secret id}
    REDIRECT_URI="http://localhost:8080/oauth"
    URL_ME="https://api.intra.42.fr/v2/me"
    PORT="3000"
    CLIENT_PORT="8080"
    HOST="localhost"

    API_EMAIL_USER='[email protected]'
    API_EMAIL_FROM='Transcendence API <[email protected]>'
    API_EMAIL_PASS='teste'

    JWT_SECRET='jwtsecret'

    DATABASE='postgres'
    DATABASE_TYPE='postgres'
    DATABASE_HOST="localhost"
    POSTGRES_USER='pguser'
    POSTGRES_PASSWORD='pgpassword'

Dependencies

• Besides the envs, its necesssary install docker-compose to run the app. Command to execute:
  docker-compose up --build

Contributors

• gsilva-v
• mmoreira
• mavinici

PT-BR

Conteúdo em Inglês

Conteúdos

• Sobre
• Ferramentas
• Como criar um arquivo de configuração
• Contribuidores

Sobre o projeto

O projeto se trata de recriar o famoso jogo pong, utilizando de ferramentas mais atuais, como React por exemplo.

Ferrametas

• Como linguagem de desenvolvimento, foi utilizado o TypeScript.
• O back-end foi desenvolvido com NestJs, um framework para typescript com diversas ferramentas que ajudaram no desenvolvimento do projeto.
• O front-end foi desenvolvido Todo com React, um dos frameworks mais utilizados para desenvolvimento web.

Como usar

Caso queira hospedar, como subir o servidor

• Caso queira subir seu proprio servidor com o projeto, devera fazer algumas configurações para o completo funcionamento das ferramentas.

ENVS

    ./web/.env

    VITE_API_HOST={Seu host}
    VITE_API_PORT={Sua porta}
    VITE_REDIRECT_LOGIN_URL={Sua url de autenticação com a intra}
    VITE_GAME_NAMESPACE="game"
    VITE_CHAT_NAMESPACE="chat"
    VITE_STATUS_NAMESPACE="status"

    ./.production.env

    ACCESS_TOKEN_URI="https://api.intra.42.fr/oauth/token"
    CLIENT_ID_INTRA={Sua chave na intra}
    CLIENT_SECRET_INTRA={Seu token na intra}
    REDIRECT_URI="http://localhost:8080/oauth"
    URL_ME="https://api.intra.42.fr/v2/me"
    PORT="3000"
    CLIENT_PORT="8080"
    HOST="localhost"

    API_EMAIL_USER='[email protected]'
    API_EMAIL_FROM='Transcendence API <[email protected]>'
    API_EMAIL_PASS='teste'
    CLIENT_ID='CLIENT_ID'
    CLIENT_SECRET='CLIENT_ID'
    REFRESH_TOKEN='TOKEn'
    EMAIL='email'

    JWT_SECRET='jwtsecret'

    DATABASE='postgres'
    DATABASE_TYPE='postgres'
    DATABASE_HOST="localhost"
    POSTGRES_USER='pguser'
    POSTGRES_PASSWORD='pgpassword'

Pacotes que devem ser intalados

• Alem da criação das envs, é necessario instalar o docker-compose para rodar o comando para subir o projeto: docker-compose up --build

Contribuidores

Links dos nossos gits

• gsilva-v
• mmoreira
• mavinici