opexdev/core

Friendly tutorial for local starting

Opened this issue · 4 comments

I want to collect a small guide how to setup the opex.dev ecosystem for local use in a few clicks.
And then write it as a part of README for each repository.
So each interested developer will be able to launch a project into several simple and quick actions.

I have discussed this with @maryarm already

I fully investigate #341


  1. What is minimal .env file for core local setup? Will be great to store it as .env.local in this repo.
  2. Is it possible to check that the core is working properly? Even docker shows UP for each container.
  3. Maybe global question in general: what is minimal collection of repositories to start whole local version of opex.
    At now I understand next variant:
  • core
  • web
  • admin
  • reverse-proxy
  • chain scanner

Please correct me if it is incorrect.

For now I have run almost everything from core's docker-compose, except kibana, filebeat and elastic.

My .env file for now:

APP_NAME=Opex
APP_BASE_URL=http://app.opex.loc
PANEL_PASS=admin
BACKEND_USER=admin
SMTP_PASS=password
OPEX_ADMIN_KEYCLOAK_CLIENT_SECRET=password
API_KEY_CLIENT_SECRET=06ca1af7-5765-4e23-83cd-1bc04306d629
KEYCLOAK_FRONTEND_URL=http://auth.opex.loc
KEYCLOAK_ADMIN_URL=http://auth.opex.loc
KEYCLOAK_VERIFY_REDIRECT_URL=http://auth.opex.loc/verify
KEYCLOAK_FORGOT_REDIRECT_URL=http://auth.opex.loc/forgot
PREFERENCES=preferences-dev.yml
KIBANA_PUBLIC_URL=http://kibana.opex.loc
FILEBEAT_API_KEY=password
VANDAR_API_KEY=password

Please correct this values, also describe where I can retrieve value for API_KEY_CLIENT_SECRET if you can.


Docker shows all containers up and running, without restarts or any problems.
But web application can't show even start page.
It makes correct request to http://api.opex.loc/api/v3/exchangeInfo and stuck after it.

Sorry for the late answer.

Please correct this values, also describe where I can retrieve value for API_KEY_CLIENT_SECRET if you can.

You can get that in keycloak panel. In clients section, there's a client named api-key-client, under credential tab, generate the secret and copy it to your .env file

But web application can't show even start page.

Have you set the environment variables correctly?

Hi
Do you have a little step by step manual how to configure it?

I'm trying to find documentation about it , but no luck

Thanks

Hi Do you have a little step by step manual how to configure it?

I'm trying to find documentation about it , but no luck

Thanks

Hey.
Sorry, at this moment, we don't have a step-by-step tutorial to setup the project, nor do we have the resources to provide you with one.
You're welcome to contribute if you managed to create one