https://github.com/nnnnicholas/opensea-metadata-refresh-cron
https://github.com/nnnnicholas/opensea-metadata-refresh-cron
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nnnnicholas/opensea-metadata-refresh-cron
- Owner: nnnnicholas
- Created: 2023-07-18T01:00:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-21T16:35:57.000Z (almost 2 years ago)
- Last Synced: 2024-04-15T05:08:12.162Z (about 1 year ago)
- Language: TypeScript
- Size: 72.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Opensea Metadata Refresh Cron Job
This cron process refreshes an ERC-721 collection's metadata on Opensea on a given schedule. This utility makes it easy to keep OpenSea's offchain cache up-to-date for a given collection.
Thanks to [BuidlGuidl](https://buidlguidl.com) for supporting this release.
## Setup
### Getting started
Clone this repository:
```bash
git clone https://github.com/yourusername/Opensea-Metadata-Refresh-Cron.git
cd Opensea-Metadata-Refresh-Cron
```
### Install dependencies
This project uses `pnpm` as a package manager. If you don't have `pnpm` installed, install it globally using `npm`:
```bash
npm install -g pnpm
```
Then the project dependencies:
```bash
pnpm install
```
### Configuration
Copy the `.example.env` file to a new file named `.env`. Fill out all fields in the `.env` file:
```bash
cp .example.env .env
```
## Development
Start the development server using `pnpm`:
```bash
pnpm dev
```
## Building for production
Build the application for production:
```bash
pnpm build
```
This command will compile the TypeScript files and output them to the `dist` directory.
## Deployment
This application is designed to be run continuously on a production server using a process manager such as `pm2`.
You can start the application without installing pm2 globally as it is already in the project dependencies:
```bash
pnpm start
```
This will start the application and keep it running, even if the server restarts.
## Logs
You can view the application logs using the provided scripts:
```bash
pnpm logs
```
## Stopping the Application
To stop the application:
```bash
pnpm stop
```
## Restarting the Application
To restart the application:
```bash
pnpm restart
```
## Removing the Application
To remove the application from `pm2`:
```bash
pnpm delete
```
## Killing `pm2`
To kill the `pm2` daemon:
```bash
pnpm kill
```