openship

Openship ist eine Betriebsplattform, die die Erfüllung von Mehrkanal ermöglicht

Website · Dokumentation · Openship Cloud

Vor Ort laufen

Um die Openship auf Ihrer lokalen Maschine zum Laufen zu bringen:

Klonen Sie das Repo

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

Benennen Sie Beispiele in .env um .Env und füllen Sie diese erforderlichen Werte aus

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

Stellen Sie sicher, dass Sie DATABASE_URL durch eine Postgres -Verbindungszeichenfolge ersetzen.

Sie können Postgres lokal ausführen oder online eine Datenbank erhalten.

Starten Sie die Anwendung

Führen Sie die folgenden Befehle aus, die Openship starten:

 $ cd openship
$ yarn install
$ yarn dev

Openship: http: // localhost: 3000

Sobald die Anwendung ausgeführt wird, gehen Sie zu Localhost: 3000. Wenn in der Datenbank keine Benutzer vorhanden sind, werden Sie in Localhost: 3000/init umgeleitet, wo Sie den Administratorbenutzer erstellen können.

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

Verwenden Sie den Spielplatz, um Abfragen/Mutationen gegen die API zu erstellen und auszuführen.

Einsatz

OpenShip verwendet Next.js. Natürlich kann es überall gehostet werden, wo node.js. Openship erfordert auch eine postgres -Datenbank.

1 Klick-Bereitstellung

Diese Bereitstellungsdienste bieten Node.js und postgres Datenbanken an, sodass Openship in 1 Klick bereitgestellt werden kann.

Eisenbahn

Machen

Vercel

Bevor Sie unten auf die Schaltfläche "Vercel Deploy" klicken, erhalten Sie unbedingt eine Postgres -Datenbankverbindungszeichenfolge. Vercel verfügt über einen Datenbankspeicher, in dem Sie eine Postgres -Datenbank erstellen können, indem Sie diese Anweisungen befolgen. Verwenden Sie unbedingt die POSTGRES_PRISMA_URL als DATABASE_URL .

Weiter.js Bereitstellung

Um auf Plattformen bereitzustellen, die Datenbanken wie Netlify nicht unterstützen, müssen Sie eine Postgres -Verbindungszeichenfolge als Variable DATABASE_URL übergeben.

Netlify

Nachdem die Website bereitgestellt wurde, müssen wir die richtige Bereitstellungs -URL hinzufügen (enden in netlify.app oder Ihrer benutzerdefinierten Domäne).

Gehen Sie zu Site -Einstellungen> Erstellen und Bereitstellen> Umgebung und fügen Sie diese Variablen hinzu:

  FRONTEND_URL=https://yourapp.netlify.app

Ersetzen Sie FRONTEND_URL durch die URL, die in netlify.app endet. Setzen Sie die Seite neu ein.

Docker

Erstellen Sie eine Kopie von Beispiele .env

 cp example.env .env

Die Projektdatase Init ist mit dem Build -System verbunden, sodass wir den Postgres -Dienst vor dem Erstellen starten müssen:

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

Erstellen Sie nun den Openship -Container selbst und starten Sie sie selbst:

 docker-compose up -d

Die Web -App sollte bei curl localhost:3100 verfügbar sein. Wenn dies nicht der Fall ist, überprüfen Sie bitte docker-compose logs .

Schließlich den localhost:3100 dem gewünschten öffentlichen Gastgeber aussetzen.

Credits

Openship wäre ohne diese großartigen Projekte nicht hier

• Weiter.js
• Keystone.js
• Prisma
• Shadcn/Ui
• Vollständige Credits