Linkd local deployment!

Please follow the instractions in order to deploy a local development environment

Setup environment

1. install Node on you machine from here.

2. install Docker on you machine from here. If using linux machine please install docker compose as well from here

3. install pnpm on you machine from here.

4. install rush on you machine from here.

5. install ipfs on your machine from here. run it as a daemon.

Run Locally

Clone the project

  git clone https://github.com/linkd-dev/linkd.git

Go to the project directory

  cd ./linkd

Run Docker

Run your newly downloaded docker desktop app

Run Docker containers

  rush deploy-local-dev

You are good to go!

View MGMT Logs

Please run docker logs -f mgmt

URLS

mgmt localhost:4001 localhost:4001/v1/mgmt/health-check

web localhost:4033

Development

After set the env and its up and running, lets see what do we have.

• postgres pod :5432
• mgmt pod (Backend API - Node) :4000
• Web pod (Frontend - React) :4033
• flyway temp pod (Run migrations on DB)

Things to know

Postgres

• When adding new tables please add it to the migrations file V1__init.sql

mgmt

• The pod is ready for development just start coding and its watch for changes on your machine. start coding and the pod will update :)

Web

• There is proxy to the API port

FAQ

How to see mgmt logs?

Please run docker logs -f mgmt

Something is not running as expected?

Please reach Matan on slack