Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 1.66 KB

guidlines.md

File metadata and controls

55 lines (33 loc) · 1.66 KB
Raw

Guidelines

This file is used to tell everyone how to build, deploy and use DouTok.

How to deploy the related dependencies

Modify ./env/dependencies.yml

./env/dependencies.yml is a configuration for docker-compose. In this file, now we import some dependencies which we need used in DouTok. In another words, we must deploy these dependencies so we can run DouTok.

In this file, now we imported:

  • Redis
  • MySQL
  • etcd
  • zookeeper
  • HBase
  • Kafka

Always we don't need to modify it but we must modify one line for Kafka.

In services.kafka.environment, there's an entry named KAFKA_ADVERTISED_LISTENERS. We should use the IP address of your local network. For example, I get my IP address by using ifconfig is 192.168.1.119 and I will configure it as KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://192.168.1.119:9092.

Don't forget modify config files for each modules, you can use a global serach for YOUR_OWN_IP to find all where you should replace with your own IP address.

Modify hosts file

Something more, modification of hosts file is needed. This will help HBase run as we expected. We should add this in our hosts file:

127.0.0.1 hb-master

Fire

Run docker-compose -f ./env/dependencies.yml up -d to deploy all dependencies.

How to build backend

For User, UserDomain, Entity, CommentDomain, Favorite:

If you are using vscode:

  1. Copy ./config/vscode_launch.jsonc to ./vscode
  2. Use vscode to run these modules.

If you are using Goland:

  1. run the shell named run.sh in each module.

For others services:

Run each modules by using go run ./applications/xxx/

How to build frontend

How to use DouTok