https://github.com/lit-protocol/lit-apps
https://github.com/lit-protocol/lit-apps
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/lit-protocol/lit-apps
- Owner: LIT-Protocol
- License: mit
- Created: 2023-01-31T14:25:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T21:33:02.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T00:07:15.646Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://lit-demo-iota.vercel.app
- Size: 5.94 MB
- Stars: 3
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚠️ Notice: End of Maintenance for This Package
This package is no longer actively maintained. Moving forward, only critical security patches will be applied. We encourage users to use the [@lit-protocol/contracts](https://www.npmjs.com/package/@lit-protocol/contracts?activeTab=versions) NPM package instead
# Prerequisite
```
yarn global add turbo
```
# Quick start
## install
```
yarn
```
## Running apps
### Starting general worker (since this is most used atm.)
```
GITHUB_LIT_ASSETS_REAL_ONLY_API=XXX turbo run dev --filter lit-general-worker -- main.ts
```
Then, you should be able to see your network contract addresses from these apis:
- http://localhost:3031/manzano-contract-addresses
- http://localhost:3031/habanero-contract-addresses
- http://localhost:3031/serrano-contract-addresses
- http://localhost:3031/contract-addresses <-- cayenne
### Starting a specific app
```
// turbo dev --filter ["name" in package.json]
turbo dev --filter playground-nextjs
```
### Starting all apps
```
yarn dev
```
### playground-nodejs
specify file name eg `node-test.mjs`, `main.mjs` in the `src` folder
```
// passing params using '--'
turbo dev --filter playground-nodejs -- node-test.mjs
```
# Setting up test on your monorepo
https://jestjs.io/docs/getting-started#using-babel
# Monorepo Workflow TODO
[] Upon building, add root .env to projects that are depended on
# Deploy Notes & Stack
- The whole repo is deployed to Heroku, but we use Procfile to separate the apps (see https://dev.to/tgmarinhodev/how-to-deploy-a-monorepo-with-turborepo-on-heroku-3ge4)
- when an app is deployed as a worker (no port exposed), you need to prefix your Procfile with `worker:`, eg:
```
worker: cd apps/event-listener-be && yarn start
```
Otherwise,
```
web: cd apps/event-listener-fe && yarn start
```
```
heroku buildpacks:add -a event-listener-fe heroku-community/multi-procfile
heroku buildpacks:add -a event-listener-fe heroku/nodejs
heroku buildpacks:add -a event-listener-be heroku-community/multi-procfile
heroku buildpacks:add -a event-listener-be heroku/nodejs
```
- pm2-runtime is used for worker app, it will be connected to the pm2 dashboard automatically when PM2_PUBLIC_KEY and PM2_SECRET_KEY env keys are provided
- hotjar is installed
# Creating a new app and setup for Heroku
## Quick Start
1. Create a `Procfile` file in your app
> A Procfile is a configuration file used by the Heroku platform to specify the command(s) required to start your application. It defines the process types and entry points for your app, allowing Heroku to understand how to run your application correctly.
```
web: cd apps/lit-general-worker && yarn start
```
2. Add buildpacks to your app
> Theses command adds a buildpack to your Heroku application, specifying that you are using the heroku/nodejs and heroku-community/multi-procfile buildpack. `heroku/nodejs` is the official Node.js buildpack provided by Heroku, and `multi-procfile` allows you to use multiple Procfiles in your application, which can be useful if you have multiple processes or applications in your repository that you want to deploy separately.
```
heroku buildpacks:add -a lit-general-worker heroku-community/multi-procfile
heroku buildpacks:add -a lit-general-worker heroku/nodejs
```
Note: if you see `› Error: Couldn't find that app. › Error ID: not_found` that's because you have to create a Heroku app first
3. Set environment variables
You can either do this in the CLI, or on the Heroku dashboard
```
heroku config:set APP_ENV=lit-general-worker -a lit-general-worker
heroku config:set PROCFILE=apps/lit-general-worker/Procfile -a lit-general-worker
heroku config:set PINATA_API_KEY=XXXXX -a lit-general-worker
heroku config:set PINATA_SECRET_KEY=XXXXX -a lit-general-worker
heroku config:set PM2_PUBLIC_KEY=XXXXX -a lit-general-worker
heroku config:set PM2_SECRET_KEY=XXXXX -a lit-general-worker
```
# Vercel setting
