chore(makefile): add `make` commands for various Node services

RSS3-Network / Node

In the vast RSS3 Network, the RSS3 Node delivers Open Information with efficiency, it is a steadfast cruiser in the byte-filled sea.

MIT License

20 stars 3 forks source link

chore(makefile): add `make` commands for various Node services #388

Closed FrankLi123 closed 3 weeks ago

FrankLi123 commented 3 weeks ago

Summary

Add new make commands in the Makefile to simplify running the worker, core, monitor, and broadcaster services locally. This includes adding comments and notes for each command to provide clear instructions for developers.

Checklist

[x] The commit message follows Angular Contributing guidelines;
[ ] Tests for the changes have been added (for bug fixes / features);

Does this PR introduce a breaking change?

[ ] Yes
[x] No

pseudoyu commented 3 weeks ago

I think more commands related to dev environment setup could be included such as redis and cockroachdb?

You can refer to the docker-compose.yml in .devcontainer/ path.

And it requires Docker and Docker Compose to be installed on the development machine, which should also be mentioned in the comments.

FrankLi123 commented 3 weeks ago

Here is the link to the Notion document 'RSS3 Node Developer Guide'. This guide is designed to help developers in using the Makefile commands to set up the development environment and run node services. Future updates will include additional instructions, such as 'how to implement new workers in the RSS3 Node'.

Notion link: https://www.notion.so/rss3/RSS3-Node-Developer-Guide-20dd6cd90741410e934807e340679d5e?pvs=4

kallydev commented 3 weeks ago

And it requires Docker and Docker Compose to be installed on the development machine, which should also be mentioned in the comments.

By the way, the latest version of Docker Compose has been built into the Docker CLI, so you can use docker compose directly instead of docker-compose.