README.md

Universalizando o acesso a dados de qualidade.

Website

Repositório do website basedosdados.org.

Este projeto é uma aplicação desenvolvida com Next.js.

Ele utiliza variáveis de ambiente para configuração e pode ser executado com npm ou com Docker Compose.

Pré-requisitos

• Node.js versão 18.20.3 (recomendado)
• npm ou Docker Compose

Instruções de configuração

Variáveis de ambiente

Para configurar o ambiente, crie um arquivo .env na pasta raiz do projeto com o seguinte conteúdo:

NODE_ENV="development"
NEXT_PUBLIC_API_URL="http://localhost:8080"
NEXT_PUBLIC_SITE_NAME="Basedosdados"
NEXT_PORT=80
NEXT_PUBLIC_BASE_URL_FRONTEND="http://localhost:3000"

Essas variáveis de ambiente são utilizadas pela aplicação para definir o ambiente de desenvolvimento e configurar as URLs da API e do site.

Executando a Aplicação

Escolha um dos métodos de inicialização abaixo para executar a aplicação.

npm

Na pasta next, instale as dependências do projeto com o comando:

npm ci

Este comando garante que todas as dependências serão instaladas com as versões especificadas em package-lock.json.

Após instalar as dependências, carregue suas .env(elas estão armazenadas na raiz do projeto):

cd ./
source .env

e inicie o servidor de desenvolvimento com:

cd next
npm run dev

Docker compose

Na raiz do projeto, certifique-se de que o arquivo .env está configurado.

Inicie a aplicação com Docker Compose:

docker-compose up

👥 Como contribuir

Leia nosso guia de contribuição