https://github.com/developer-dao/web3con-hackathon-discord-onboarder
A simple node.js script to onboard hackathon registrants onto discord via CSV.
https://github.com/developer-dao/web3con-hackathon-discord-onboarder
Last synced: 12 months ago
JSON representation
A simple node.js script to onboard hackathon registrants onto discord via CSV.
- Host: GitHub
- URL: https://github.com/developer-dao/web3con-hackathon-discord-onboarder
- Owner: Developer-DAO
- License: mit
- Created: 2022-02-07T04:47:15.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-26T02:20:24.000Z (almost 4 years ago)
- Last Synced: 2025-01-13T15:17:24.901Z (about 1 year ago)
- Language: TypeScript
- Size: 108 KB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# web3con-hackathon-discord-onboarder
[](#contributors-)
A simple node.js script to onboard hackathon registrants onto discord via CSV.
## Prerequisites
0. [ts-node](https://github.com/TypeStrong/ts-node)
1. [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable)
2. [nvm](https://github.com/nvm-sh/nvm)
## Usage
### How to build
0. Run `nvm install` in the project root directory
1. Run `yarn` to pull in the dependencies
### Content source
The script uses the `resources/hackers.csv` as the source of truth when preforming preforming discord onboardings.
### Command Line Options
The script runs entirely through the command line and can be run with the following command and option below:
**Options**
- `-d, --dryrun ` : Run the script in dryrun mode which will not upload to the blockchain giving you a chance to observe requests before committing to uploading. Defaults to *true* if not passed
### How to run the script
0. Open up a terminal and traverse to the project root i.e. `cd some/path/to/web3con-hackathon-discord-onboarder`
1. Replace the content of `resources/hackers.csv` with the data of your liking,
2. Run `ts-node onboarder.ts -d true` to run the script in `dryrun` mode to observe how your requests will look like without actually uploading.
3. Observe the `logs/service.log` file to see if your data looks like you expect it to
4. Assuming you are satisfied with your dryrun and/or testweave uploads you can now upload to the Arweave mainnet via `ts-node onboarder.ts -d false -t false`
5. Once the upload is finished, observe the `logs/service.log` file to see the results
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
