@@ -6,19 +6,49 @@ Solana NFT bot is a helpful bot for your Solana NFT projects.
6
6
- [x] Notify discord channel on each purchase in marketplaces.
7
7
- [x] [ Support major marketplaces] ( #marketplace-support )
8
8
9
- ## Running locally
9
+ ## Running in development
10
10
### Requirement
11
11
* Node >= 16.6
12
12
* Yarn
13
13
14
14
### Instructions
15
15
16
- 1 . Install dependencies
16
+ #### 1. Install dependencies
17
17
```
18
18
yarn install
19
19
```
20
20
21
- 2 . Update .env with your secrets
21
+ #### 2. Update .env with your secrets
22
+
23
+ Follow the instructions [ here] ( #configurable-environments )
24
+
25
+ #### 3. Run the server
26
+ ```
27
+ yarn dev
28
+ ```
29
+
30
+ ## Running using docker
31
+
32
+ ### Requirement
33
+ * [ docker] ( https://www.docker.com/products/docker-desktop ) >= v20.10
34
+
35
+ ### Instructions
36
+
37
+ #### 1. Update .env with your secrets
38
+
39
+ Follow the instructions [ here] ( #configurable-environments )
40
+
41
+ #### 2. Run bot using docker compose in the terminal
42
+ In the terminal run the follow command in the repo directory:
43
+
44
+ ```
45
+ docker-compose up bot
46
+ ```
47
+
48
+ ## Configurable environments
49
+
50
+ Here are a list of environments you need to configure before running the NFT bot.
51
+
22
52
``` sh
23
53
# Replace this with your RPC
24
54
SOLANA_RPC=https://explorer-api.mainnet-beta.solana.com/
@@ -29,9 +59,12 @@ SUBSCRIPTION_DISCORD_CHANNEL_ID=
29
59
# Mint address to watch for sales
30
60
SUBSCRIPTION_MINT_ADDRESS=
31
61
```
62
+ https://github.com/milktoastlab/SolanaNFTBot/blob/main/.env
63
+
64
+ ### Variable breakdowns
32
65
33
66
#### DISCORD_BOT_TOKEN
34
- This is your discord bot secret.
67
+ This is your discord bot secret.
35
68
If you don't have a discord bot yet, you can create one following the instructions here:
36
69
https://discordpy.readthedocs.io/en/stable/discord.html
37
70
@@ -56,12 +89,6 @@ Ideally, it's the "Update Authority" address.
56
89
<img width =" 587 " alt =" Screen Shot 2021-10-31 at 9 30 56 am " src =" https://user-images.githubusercontent.com/90617759/139560515-efd2f584-8f98-4337-a9ad-704b18581b22.png " >
57
90
58
91
59
- 3 . Run the server
60
- ```
61
- yarn dev
62
- ```
63
-
64
-
65
92
## Marketplace support
66
93
67
94
- [x] [ Magic Eden] ( https://magiceden.io/ )
0 commit comments