openship

OpenHip é uma plataforma de operações que permite o cumprimento de vários canais

Site · Documentação · OpenShip Cloud

Executando localmente

Para fazer o OpenShip em execução em sua máquina local:

Clone o repo

 git clone https://github.com/openshiporg/openship

Renomear exemplo.env para .env e preencha esses valores necessários

//.env
FRONTEND_URL=http://localhost:3000
DATABASE_URL=postgresql://postgres:example@url:3000/postgres
SESSION_SECRET=OH_PLEASE_PLEASE_PLEASE_CHANGE_ME

Certifique -se de substituir DATABASE_URL por uma string de conexão PostGres.

Você pode executar o PostGres localmente ou obter um banco de dados online.

Inicie o aplicativo

Execute os seguintes comandos Start Up OpenShip:

 $ cd openship
$ yarn install
$ yarn dev

OpenHip: http: // localhost: 3000

Quando o aplicativo estiver em execução, vá para localhost: 3000. Se não houver usuários no banco de dados, você será redirecionado para localhost: 3000/init, onde poderá criar o usuário administrador.

GraphQL Playground: http: // localhost: 3000/api/graphql

Use o playground para construir e executar consultas/mutações contra a API.

Implantação

O OpenShip usa o Next.js, então, naturalmente, pode ser hospedado em qualquer lugar que suporta Node.js. O OpenShip também requer um banco de dados postgres .

Implantação de 1 clique

Esses serviços de implantação oferecem bancos de dados Node.js e postgres para que a OpenShip possa ser implantada no 1-clique.

Ferrovia

Renderizar

Vercel

Antes de clicar no botão VERCEL IMPLONHAIXO ABAIXO, certifique -se de obter uma string de conexão do banco de dados do PostGres. A Vercel possui armazenamento de banco de dados, onde você pode criar um banco de dados do PostGres seguindo estas instruções. Certifique -se de usar o POSTGRES_PRISMA_URL como DATABASE_URL .

Next.js implantação

Para implantar em plataformas que não suportam bancos de dados como o NetLify, você precisará passar uma string de conexão PostGres como a variável DATABASE_URL .

Netlify

Depois que o site é implantado, precisamos adicionar o URL de implantação correto (terminando no netlify.app ou seu domínio personalizado).

Vá para Configurações do Site> Construir e Implantar> Ambiente e adicione estas variáveis:

  FRONTEND_URL=https://yourapp.netlify.app

Substitua FRONTEND_URL pelo URL que termina no netlify.app. Reimplementar o site.

Docker

Crie uma cópia do exemplo.env nomeado .env e cusotmize o segredo da sessão, bem como o usuário/senha/dbname do Postgres como desejar:

 cp example.env .env

O Project Datase Init está associado ao sistema de construção, por isso temos que iniciar o serviço Postgres antes de construir:

 mkdir ./volumes/postgres/data
docker-compose up -d postgres

Agora construa e inicie o próprio contêiner de abertura:

 docker-compose up -d

O aplicativo da Web deve estar disponível no curl localhost:3100 . Caso contrário, verifique docker-compose logs .

Finalmente, exponha o localhost:3100 ao anfitrião público desejado.

Créditos

OpenShip não estaria aqui sem esses grandes projetos

• Next.js
• Keystone.js
• Prisma
• Shadcn/ui
• Créditos completos