Document APIs

[franswan]

I though this would be a good intro to the project that @neuro0x and I could do together to get you up to speed on the app.

Can get your local dev env running as well.

[neuro0x]

Please email .env files to neuro_0x@proton.me

[franswan]

Sent.

I've sent a Vercel invite too. Main branch is deployed there. The DB is wired up to Planetscale. I've added you as an admin there as well. There is no dev branch of the db. Until now I just run main repo branch locally and work straight off the "production" bnarch of the db, which is the only branch.

The main vars for local to run without complaining will be the database ones. The "falcon" vars are needed only if testing creation of peers on the actual network.

The wallet vars can be changed to whatever test wallets you want to use. They are hooked up to the claims links atm. Testing easily done by creating record in the db in the Claim table for the wallet you are logged in to the app with. More on all that later...

The AWS and SSH key stuff is related to a job running metaboss on an EC2 and an S3 bucket for profile images. The metaboss job is just running a NFT count per user and gives us an endpoint to read when we run the settlements jobs on vercel.