Nomad DB

A decentralised P2P database format designed with an emphasis on ownership and anonymity which aims to support Individual and Communal instances through shared data with the hope of fostering a community of apps that store and share data on the network.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A decentralised P2P database format designed with an emphasis on ownership and anonymity which aims to support Individual and Communal instances through shared data with the hope of fostering a community of apps that store and share data on the network.

(back to top)

Getting Started

Prerequisites

Install go>=1.20

• go
  • Go to the golang download page and follow the instructions
• Python
  • Go to the python download page and follow the instructions

Installation

1. Clone the repo

   git clone https://github.com/neutrino2211/NomadDB.git

2. Install Go packages

   cd NomadDB && go get

3. Test run the program to make sure it is working

   go run .

(back to top)

Usage

Only the most basic cluster instance exists and to run it, start a cluster.

go run . database

Then interact with the cluster on port 13564 with the python script in test-client/interact.py

• Write data

python interact.py -o <your_username> -d <content_to_store>

This should print some diagnostic messages and if it gets an "ok" response, it will print three things.

• ID of the file that stored the content within the cluster
• The content hash
• The length of the content hash [should be 64]

• Fetch data

python interact.py -o <your_username> -m fetch -r <the_content_hash>

This should print some diagnostic messages and if it gets an "ok" response, it will print the 2048 byte block content

• Delete data

python interact.py -o <your_username> -m delete -r <the_content_hash>

This should print some diagnostic messages and an empty byte string

(back to top)

Roadmap

• Clusters
• Nodes of clusters
• Registries

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Your Name - @neutrino2211 - tsowamainasara@gmail.com

Project Link: https://github.com/neutrino2211/NomadDB

(back to top)

Acknowledgments

• Best Read Me

(back to top)