Instructions on running local dev instance

[ckoopmann]

@alextes - Thanks a lot for inviting me to the repo. As mentioned I'd love to help out with adding additional analysis timeframes (or any other task where I could help).

Currently I'm still somewhat struggling to get a local setup running of the server.

While starting the containers with docker compose up generally works, I haven't found a way yet to "sync" my local instance to fill the database with the analysis results and enable me to test out the api endpoints.

I have tried the various scripts that I could find in the source code but the only one I've gotten to work is reanalyze_eth_prices (After swapping out the ftx for the binance api).

It'd be great if someone could share some instructions / guidance on how to get a local instance into a functional state comparable to the production one.

I love the project and would much appreciate any help and guidance🙏

[alextes]

@ckoopmann Ah, let me remove the docker-compose.yaml. Hasn't been used in a long time.

Running it is a bit tricky. Not because of set-up ceremony. Setting up is real easy, you just need a handful of environment variables. Running is more difficult because much of the code doesn't run until your DB has caught up with the chain. This takes many days because millions of blocks, slots, and ~billion transactions need to be pulled. Personally I have a service running 24/7 that keeps a DB up to date. I turn that service off when I want to develop locally so I can develop against a DB that's caught up with the chain.

Couple options:

• Best option I think is I give you access to our dev DB, you can create a dump (36GB), restore it locally, then run the service against it. The one caveat is you'll have to keep it running somehow, or be content waiting for it to catch up next time you need it. Currently the service catches up at a rate of 1 block/s. So not running for one day means 2h needed to catch back up.
• You could write a little script that can connect to our dev DB, then sync the state to a local DB. You need maybe three or so tables to run this service. That way after using a dump once you should be able to get back in sync in seconds.
• If you're more serious about contributing, maybe after a PR or two, I'm also happy to set you up with an environment like mine, where you have access to your own dev DB, your own service which runs 24/7, that you can easily toggle off.

Can you write me on Telegram? https://t.me/smilingalex I'll give you the secret environment variables.