Skip to content

Latest commit

 

History

History
135 lines (91 loc) · 3.49 KB

README.md

File metadata and controls

135 lines (91 loc) · 3.49 KB
Raw
logo

Kinto network status service

UADE Informatics Engineering thesis project - 2022

Kinto network service, handles nodes and node related operations.

Documentation · Report Bug · Request Feature


📔 Table of Contents

🌟 About the Project

This service manages nodes conections, registers nodes, calculates healthchecks and updates on the peers network.

👾 Tech Stack

🎯 Features

  • Registers and conect nodes
  • Maintains registry of node confidence values
  • Alows users to manage their nodes through Kinto Front End UI

🧰 Setup

‼️ Prerequisites

  • Node This project uses node and npm as package manager, make sure it is installed.
 node -v
 npm -v
  • Redis This project uses redis to store nodes information Create a redis search local image, you can set up a local redis docker container by executing the following command
docker run -it --rm --name redis-stack -p 6379:6379 redis/redis-stack:latest

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

REDIS_CLIENT_URL redis databese to store nodes information.

PORT where the service will listen to.

SERVICE_URL endpoint of your service.

Ipfs network configuration, new nodes will use to provide resources to the network. IPFS_REPO IPFS_API IPFS_GATEWAY IPFS_RPC

⚙️ Usage

Clone the project

  git clone https://github.com/K-nto/Kinto-network-status-service.git

Go to the project directory

  cd Kinto-network-status-service

Install dependencies.

  npm install

Start the service.

  npm run start

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.

🤝 Contact

Federico Javier Parodi - Fedejp - Linkedin - Github

Carlos Santiago Yanzon - Bizk - Linkedin - Github

Project Link: https://github.com/K-nto

💎 Acknowledgements

We thank and aknowledge the authors of these resources for their work.