atxdao website

contributing

install dependencies

1. yarn install

editor setup

1. download + open atxdao website with vscode
2. go to the extensions view with (ctrl|cmd)+shift+x
3. search for @recommended and install the workspace recommended eslint and prettier extensions

.env

1. Copy .env.example to .env
2. Change any variables necessary for your environment (see services below)

developing on the site

1. run yarn dev to launch the site at localhost:3000 and it will automatically reload any changes you make
2. when you are happy with a set of changes, run yarn lint && yarn build and fix any errors.
3. open up a pull request
4. get a review by @clifton or @jongregis
5. your changes will be merged and automatically deployed

resources

1. we use chakra-ui as our design framework. check out the docs!
2. we use nextjs to statically build the site
3. and deploy to github pages

services

EventBrite

1. You'll need to set up an API Key on the EventBrite site under API Keys
2. Use the Private Token for NEXT_PRIVATE_EVENTBRITE_KEY in .env
3. Create at least one event (it may need to be paid)
4. Get your organization ID by listing organizations using the API Docs
5. Put your organization ID into NEXT_PRIVATE_EVENTBRITE_ORGID in .env