ogre-net

'Ogres are like onions.'

[](https://github.com/AdamCollins/ogre-net) [](https://github.com/AdamCollins/ovre-net/issues) ## About The Project ogre-net is a simple yet completely decentralized [onion routing](https://en.wikipedia.org/wiki/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 ```sh install go 1.15 ``` ### Installation * Clone the repo ```sh git clone https://github.com/AdamCollins/ogre-net.git ``` ### Running 1. Build ```sh make all ``` 2. Start up node ```sh ./build/node -id= -listen= -knows=

``` ## Documentation For documentation please refer to the docs folder or checkout this doc [here](https://viewer.diagrams.net/?highlight=0000ff&edit=_blank&layers=1&nav=1&title=OgreNetArchitecture.drawio#Uhttps%3A%2F%2Fraw.githubusercontent.com%2FAdamCollins%2Fogre-net%2Fmain%2Fdocs%2FOgreNetArchitecture.drawio) 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. [contributors-shield]: https://img.shields.io/github/contributors/AdamCollins/repo.svg?style=for-the-badge [contributors-url]: https://github.com/AdamCollins/repo/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/AdamCollins/repo.svg?style=for-the-badge [forks-url]: https://github.com/AdamCollins/repo/network/members [stars-shield]: https://img.shields.io/github/stars/AdamCollins/repo.svg?style=for-the-badge [stars-url]: https://github.com/AdamCollins/repo/stargazers [issues-shield]: https://img.shields.io/github/issues/AdamCollins/repo.svg?style=for-the-badge [issues-url]: https://github.com/AdamCollins/repo/issues [license-shield]: https://img.shields.io/github/license/AdamCollins/repo.svg?style=for-the-badge [license-url]: https://github.com/AdamCollins/repo/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://www.linkedin.com/in/adam-collins-dev/