The Unofficial GhostNet Documentation Project

Generates a website of GhostNet information.
View Demo

About The Project

S2 Underground is developing the concept of GhostNet, a collection of communications networks set up to allow users around the world to exchange information without relying on pre-established infrastructure. I really like the idea, and the 4" x 6" PDF document he publishes is very useful, but I would also like the information to be available as a website and in a variety of standard print sizes.

This project builds a website containing S2 Underground's GhostNet information, and PDFs for download to print.

I am not affiliated with S2 Underground, so any feedback on GhostNet as a project should be directed toward the creator of that project.

Built With

• 
• 

(back to top)

Getting Started

Prerequisites

• Node.js

You can check whether you have Node installed by running node --version in a terminal window. If the command is not found, or it reports a number lower than 14, you will need to download and install Node.js before continuing.

• git

You can check whether you have git installed by running git --version in a terminal window. If the command is not found, you will need to download and install git before continuing.

Installation

1. Clone the repo

   git clone https://github.com/TurnerSoftwareDev/GhostNet.git
   cd GhostNet

2. Install NPM packages (this takes a while)

   npm install

3. Run locally for developing the website

   npm start

   Then navigate in your browser to http://localhost:8080. Your browser will automatically load any changes you make while developing, so you don't have to keep hitting the refresh button.

   Update the PDFs with the latest website build.

   npm run pdf

4. Generate website assets and PDFs for deployment

   npm run build

   The website assets to deploy will be found in the _site directory.

   Update the PDFs with the latest website build.

   npm run pdf

(back to top)

Roadmap

• Generate a website with content from the first two pages of S2U's PDF
• Create a 4" x 6" printable PDF from the website
• Format the 4x6 PDF to look similar to the original
• Add the remaining content to the website and 4x6 PDF from S2U's PDF, and format them nicely
• Set up a domain name for the website
• Create additional standard-size printable PDFs from the website
  • A5
  • A4
  • Wallet size

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

Software is distributed under the ISC License. See LICENSE.txt for more information.

Rights to the content (i.e. written text) about GhostNet are retained by S2 Underground.

(back to top)

Contact

Eric Turner - @EricTheTurner - eric@ericturner.dev

Project Link: https://github.com/TurnerSoftwareDev/GhostNet

(back to top)

Acknowledgments

• @s2underground (GitHub)
• @S2Underground (YouTube)
• @s2_underground (X)

(back to top)