ogre-net

'Ogres are like onions.'

About The Project

ogre-net is a simple yet completely decentralized onion routing network designed to help practice network programming, encryption, distributed systems, and scalability.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• go

  install go 1.15

Installation

• Clone the repo

  git clone https://github.com/AdamCollins/ogre-net.git

Running

1. Build

   make all

2. Start up node

   ./build/node -id=<NodeID> -listen=<port to lisen on eg. :3001> -knows=<address of prexisting node eg. :3000 (leave blank if first) >

Documentation

For documentation please refer to the docs folder or checkout this doc here for an overview.

Contributing

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

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

License

Distributed under the MIT License.