Skip to content

SeerIntelligence/Juoru

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Juoru

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, linkedin_username, email, email_client, project_title, project_description

(back to top)

Languages

  • C++ for encryption and decryption
  • Python for server management

(back to top)

Getting Started

A client serves both as a node and a user, so you'd only need to run one client.

Prerequisites

Currently we only need some Python modules to run.

  • Python
    pip install -r requirements.txt

Installation

  1. Clone the repo
      git clone https://github.com/github_username/repo_name.git
  2. Compile
      make
  3. Install
      make install

Creating nodes

On a local environment you'd need to change the port that the node runs on, it's specified in the python file (NOT THE MODULE).

I'll make a simple handler than runs both the server/node and the C++ apps. //TODO

(back to top)

Usage

Relationships and address books:

An addressbook is a database file that associates the JIP of nodes with their real IP address, this is to prevent others from seeing the real IP of nodes when viewing the relationships online. Every node has a constant connection to every other node that's related to him. To make a connection to a new node, first you've got to establish a relationship and a relationship is established when the receiving node's IP address is stored in your addressbook. to get the address of people that you don't know, you'd send an address request to other nodes that may know the IP of your target node and they'd respond back with their IP address which would match with the hash in the JIP address when hashed.

//todo explain further

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • [] Make a prototype
  • [] Encryption
  • [] Darkness
    • [] Choice of darkness

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 (I did that)

(back to top)

License

Distributed under the GNU general public License. See LICENSE.md for more information.

(back to top)

Contact

Soon.

(back to top)

Acknowledgments

(back to top)