openship

L'oubli est une plate-forme d'opérations qui permet l'accomplissement multicanal

Site Web · Documentation · Cloud d'ouverture

Courir localement

Pour faire fonctionner l'ouverture sur votre machine locale:

Cloner le repo

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

Renommer l'exemple.env à .env et remplir ces valeurs requises

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

Assurez-vous de remplacer DATABASE_URL par une chaîne de connexion Postgres.

Vous pouvez exécuter Postgres localement ou obtenir une base de données en ligne.

Démarrer la demande

Exécutez les commandes suivantes Start Up Openhip:

 $ cd openship
$ yarn install
$ yarn dev

Openhip: http: // localhost: 3000

Une fois l'application en cours d'exécution, accédez à LocalHost: 3000. S'il n'y a pas d'utilisateurs dans la base de données, vous serez redirigé vers localhost: 3000 / init où vous pouvez créer l'utilisateur administrateur.

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

Utilisez le terrain de jeu pour construire et exécuter des requêtes / mutations contre l'API.

Déploiement

OpenShip utilise Next.js, donc naturellement, il peut être hébergé n'importe où qui prend en charge Node.js. L'oubli nécessite également une base de données postgres .

Déploiement en 1 clic

Ces services de déploiement offrent des bases de données Node.js et postgres , de sorte que l'ouverture peut être déployée en 1 clic.

Chemin de fer

Rendre

Vercel

Avant de cliquer sur le bouton Vercel Deploy ci-dessous, assurez-vous d'obtenir une chaîne de connexion de la base de données Postgres. Vercel a un stockage de base de données où vous pouvez créer une base de données Postgres en suivant ces instructions. Assurez-vous d'utiliser le POSTGRES_PRISMA_URL en tant que DATABASE_URL .

Déploiement suivant.js

Pour déployer sur des plates-formes qui ne prennent pas en charge les bases de données comme Netlify, vous devrez passer une chaîne de connexion Postgres comme variable DATABASE_URL .

Gré

Une fois le site déployé, nous devons ajouter l'URL de déploiement correcte (se terminant dans Netlify.app ou votre domaine personnalisé).

Accédez à Paramètres du site> Build & Deploy> Environment et ajoutez ces variables:

  FRONTEND_URL=https://yourapp.netlify.app

Remplacez FRONTEND_URL par l'URL se terminant dans netlify.app. Redéployer le site.

Docker

Créez une copie de l'exemple.env nommé .env et Cusotmize the Session Secret, ainsi que l'utilisateur / mot de passe de Postgres comme vous le souhaitez:

 cp example.env .env

Le projet Datase Init est associé au système de construction, nous devons donc démarrer le service Postgres avant la construction:

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

Maintenant, construisez et démarrez le conteneur d'ouverture lui-même:

 docker-compose up -d

L'application Web doit être disponible chez curl localhost:3100 . Si ce n'est pas le cas, veuillez vérifier docker-compose logs .

Enfin, exposez le localhost:3100 à l'hôte public souhaité.

Crédits

L'oubli ne serait pas là sans ces grands projets

• Next.js
• Keystone.js
• Prisma
• Shadcn / ui
• Crédits complets