https://github.com/d-h-o-r-a/viper-king-swap

https://github.com/d-h-o-r-a/viper-king-swap

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/d-h-o-r-a/viper-king-swap
• Owner: D-H-O-R-A
• License: mit
• Created: 2025-01-03T21:33:23.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-02-01T09:08:53.000Z (3 months ago)
• Last Synced: 2025-02-08T23:34:45.040Z (3 months ago)
• Language: TypeScript
• Size: 38.3 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        

# 🐍 Viper King Frontend

Este projeto contém os principais recursos da aplicação **Viper King**. Ele pode ser configurado e executado tanto com Docker quanto manualmente.

## 🚀 Pré-requisitos

Antes de começar, verifique se você possui as ferramentas abaixo instaladas:

- **Com Docker**:

  - Docker e Docker Compose

- **Sem Docker**:

  - Node.js v20.12.1

  - npm v10.9.0

  - pnpm (instalado globalmente)

---

## 🐳 Iniciando com Docker

1. **Clone o repositório**

   ```bash

   git clone https://github.com/sua-conta/viper-king-frontend.git

   cd viper-king-frontend

   ```

2. **Inicie os serviços**

   Execute o comando abaixo para construir e iniciar os containers:

   ```bash

   docker-compose up --build

   ```

3. **Acesse o aplicativo**

   O aplicativo estará disponível em `http://localhost:3000`.

4. **Parar os serviços**

   Para interromper os serviços, use:

   ```bash

   docker-compose down

   ```

---

## ⚙️ Iniciando sem Docker

1. **Clone o repositório**

   ```bash

   git clone https://github.com/sua-conta/viper-king-frontend.git

   cd viper-king-frontend

   ```

2. **Instale as dependências**

   Certifique-se de que o pnpm esteja instalado globalmente:

   ```bash

   npm install -g pnpm

   pnpm install

   ```

3. **Inicie o servidor de desenvolvimento**

   ```bash

   pnpm dev

   ```

4. **Construa o projeto para produção**

   ```bash

   pnpm build

   ```

5. **Inicie o servidor em modo de produção**

   ```bash

   pnpm start

   ```

6. **Acesse o aplicativo**

   O aplicativo estará disponível em `http://localhost:3000`.

---

## 📝 Notas Adicionais

- **Configuração do Nginx**:

  - Se estiver usando Docker, o Nginx já estará configurado para servir a aplicação.

  - Caso precise configurar manualmente, utilize o arquivo de exemplo `nginx.conf` fornecido no repositório.

- **Logs do servidor**:

  - Com Docker: Utilize `docker logs ` para visualizar os logs.

  - Sem Docker: Os logs serão exibidos no terminal durante a execução.

---

## 🛠 Contribuição

Se você deseja contribuir, por favor, consulte o [guia de contribuição](./CONTRIBUTING.md).

---

## 📄 Licença

Este projeto é distribuído sob a licença MIT. Consulte o arquivo [LICENSE](./LICENSE) para mais informações.