An open-source web application for analyzing Cyberyen blockchain data metrics. This README provides detailed instructions for setting up and running the Explorer application on your system.
-
Redis Server:
sudo apt-get install redis-server
-
Poetry (Python Dependency Management Tool):
curl -sSL https://install.python-poetry.org | python3 -
-
PostgreSQL (Database):
sudo apt-get install postgresql sudo -u postgres psql postgres=# create database db; postgres=# alter user postgres with encrypted password 'DO_NOT_USE_postgresql_db_password_DO_NOT_USE'; postgres=# grant all privileges on database db to postgres;
-
Clone the Explorer repository:
git clone https://github.com/cyberyen-squat/explorer
-
Navigate to the Explorer directory:
cd explorer
-
Edit the configuration file
app/config.py
with your text editor and add all necessary configurations. Here's how you can generate randomized keys forapp_key
orcsrf_key
:python >>> import secrets >>> alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789" >>> multiplier = secrets.choice(range(1, 16)) >>> the_length = 64 * multiplier >>> new = [secrets.choice(alphabet) for x in range(1, the_length)] >>> print(''.join(new))
-
Install dependencies:
poetry install
-
Load database:
poetry run python app/first_run.py
-
Run Explorer using Gunicorn:
poetry run gunicorn --workers 4 --threads 3 app:application -b :<port>
sudo apt-get install nginx
-
Create a new NGINX configuration file:
sudo $editor /etc/nginx/sites-available/explorer
-
Add the provided NGINX configuration.
-
Edit the NGINX configuration file:
sudo $editor /etc/nginx/nginx.conf
-
Add the additional configurations provided.
sudo ln -s /etc/nginx/sites-available/explorer /etc/nginx/sites-enabled/
sudo systemctl restart nginx
sudo $editor /etc/systemd/system/explorer.service
- Copy and paste the provided service configuration into the file.
sudo systemctl enable explorer
sudo systemctl start explorer
Please ensure that you replace placeholders like <port>
, <user>
, <password>
, <group>
, and IP_HERE
with actual values relevant to your system configuration.
Explorer is an open-source and community-driven software. The development process is open and publicly visible; anyone can see, discuss, and work on the software.
We welcome your feedback, questions, and suggestions! Feel free to connect with us:
-
GitHub Issues: If you encounter any bugs or have feature requests, please open an issue on GitHub.
-
Matrix: Join our c¥talk [Matrix] to see what's going on, meet people, discuss, learn about Cykuza & Cyberyen, give or ask for help, and share your ideas.
We value your input and strive to make Explorer a better tool for Cyberyen blockchain exploration and analysis. Don't hesitate to reach out!