Skip to content

Commit

Permalink
add native windows setup doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Kruceo committed Nov 8, 2024
1 parent 7c4c981 commit ad67c62
Showing 1 changed file with 93 additions and 0 deletions.
93 changes: 93 additions & 0 deletions docs/setup/WINDOWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Widnows

Guia para instalação em um ambiente Windows.

## Requisitos

- [NodeJS v21.0.0](https://nodejs.org/en) - Runtime de Javascript
- [PostgresSQL](https://www.postgresql.org/download/) - Database
- [Thermal-Printer](https://github.com/Kruceo/thermal-printer) - Servidor para impressoras térmicas

## Instalação

### Passo 1 - Database

Para o projeto funcionar é necessário um `database`, o modelo recomedando é `PostgreSQL`.

- [Windows PostgreSQL Downloads](https://www.postgresql.org/download/windows/)

### Passo 2 - Thermal-Printer

Clone o repositório [thermal-printer](https://github.com/Kruceo/thermal-printer) e siga os passos de compilação [**especificos para funcionar do Windows**](https://github.com/Kruceo/thermal-printer?tab=readme-ov-file#running-from-source-on-windows).

Configure de acordo com a documentação e execute o servidor, dependendo da sua compilação pode ser diferente:

```bash
thermal-printer.exe
```

### Passo 3 - Repositório

Clone ou baixe o zip do repositório do github e o acesse:

```bash
git clone https://github.com/Kruceo/easyfish.git
cd easyfish
```

### Passo 4 - Backend

Os passos a seguir ocorrem dentro do diretório `./easyfish/backend`.

Instalar depêndencias:

```bash
npm i
```

Devemos ajustar o arquivo de configuração do Backend em `./config/config.json`, se precisar de mais informações, consulte [BACKEND/CONFIG](https://github.com/Kruceo/easyfish/blob/main/docs/backend/CONFIG.md).

Finalmente podemos iniciar o servidor, utilizando:

```bash
node index.mjs
```

### Passo 5 - Frontend

Os passos a seguir ocorrem dentro do diretório `./easyfish/frontend`.

Instalar depêndencias:

```bash
npm i
```

Devemos ajustar o arquivo de configuração do Backend em `./config.json`, se precisar de mais informações, consulte [FRONTEND/CONFIG](https://github.com/Kruceo/easyfish/blob/main/docs/frontend/CONFIG.md).

Agora devemos compilar o codigo do frontend:

```bash
npm run build
```

Isso vai gerar novos arquivos dentro da pasta `dist`, estes são todos os arquivos necessários para o frontend.

Existem varias formas de prosseguir a partir daqui, podemos usar servidores como `Nginx` e `Apache` ou até mesmo afim de ser rapido e pratico, utilizar `python http server` e o próprio `vite`.

Neste exemplo utilizaremos o `vite` como servidor por ser mais prático, mas para produção recomendamos o `Nginx`.

```bash
cd dist
npx vite --host --port 8081
```

Esse comando iniciara um servidor de testes na porta 8081.

Considere utilizar o `Nginx` ou outro servidor de sua confiança para produção.

A partir daqui você pode acessar http://localhost:8081 (ou o endereço posteriormente configurado).

Se tudo ocorreu bem, você vai chegar a tela de login.

Para criar um usuario e senha você pode executar o `userManager.mjs`, encontrado dentro da pasta `tools` do backend.

0 comments on commit ad67c62

Please sign in to comment.