drelocatelli/uno-online

Discord: https://discord.gg/suVx3AC6m5

Uno-Online

Uno Online para se divertir com os amigos.

Tabela de conteúdos

• Sobre
• Tabela de Conteudo
• Ajustes e Melhorias
• Documentação Server Side
• Pré Requisitos
• Instalando Uno Online
• Usando Uno Online
• Contribuindo
• Colaboradores
• Licença

🔧 Ajustes e melhorias

O projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:

• Tarefa 1

📚 Documentação do server-side

Ler documentação

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

• Docker
• Docker-compose

Importante⚠️: Dentro das pastas server e client, copie o conteúdo do arquivo .env.example e crie um arquivo .env com o conteúdo copiado.

🚀 Instalando Uno Online

1. Acesse a pasta do projeto.
2. Execute o comando abaixo para subir a máquina:

docker-compose up

☕ Usando Uno Online e Jogando com amigos!

🎮 Jogando com amigos [método 1]

• Para convidar seus amigos para jogar, você precisará abrir a DMZ (conhecido também como abrir portas) do seu roteador.
• Após isso, acesse esse site e copie o endereço de IP Público: https://meuip.com.br/
• Copie o IP e adicione a porta nele, por exemplo:

127.0.0.1:PORTA

• Agora, basta enviar o link para seus amigos e começar a jogar!

🎮 Jogando com amigos [método 2]

• Esse projeto tem um recurso chamado ngrok que permite que você crie um link público para jogar com seus amigos.
• Para isso, basta acessar o site https://ngrok.com/ e criar uma conta.
• Após criar a conta, copie o token e preencha AUTH_TOKEN= dentro do arquivo /client/.env.
• Agora, basta executar o comando abaixo para subir o projeto com as configurações do ngrok:

docker-compose --env-file=client/.env up

• O link que você vai enviar para seu amigos você pegará em: localhost:4551
• Obs: Envie para seu amigo o link em http e não em https.

📫 Contribuindo para Uno Online

Para contribuir com Uno Online, siga estas etapas:

1. Bifurque este repositório.
2. Crie um branch: git checkout -b <nome_branch>.
3. Faça suas alterações e confirme-as: git commit -m '<mensagem_commit>'
4. Envie para o branch original: git push origin uno-online / <local>
5. Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

🤝 Colaboradores

Agradecemos às seguintes pessoas que contribuíram para este projeto:

4ndr3224

Guilherme S. Barros

📝 Licença

Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.

⬆ Voltar ao topo