A simple gopher server for Node-JS.

1. Install using npm install gopher-server

2. Create the server

   const { GopherServer } = require("gopher-server");
   
   let server = new GopherServer();

3. Start the server

   server.listen(70);

Content is created through routers. Different routers have different jobs.

The static router serves content based on files. So, files are layed out like the server will display them.

static
- .gophermap
  content1
  dir1
  - .gophermap
    content2

When accessing a directory, the directory's .gophermap is sent. When the requested resource is a file, the file is sent.

Here is what a .gophermap file may look like.

iHello World	fake	(NULL)	0
0Content 1	/content1	localhost	70

Gopher maps can be confusing to make at first, so the wikipedia page is a good resource. Keep in mind that localhost needs to be changed to your server's hostname. For example, example.com.

app.use(
	new StaticRouter(path.join(__dirname, "static"))
);

The dynamic router serves content programmatically. Take for example the dynamic route /test/:id. :id can be replaced by any value. This value can then be used to render and send content to the user.

app.use(
	new DynamicRouter("/test/:id", (request, params) => {
		request.send(`You sent an ID of ${params.id}.`);
	})
);

The URL router simply redirects all "URL:" requests to a redirect page. It's more of a utility, and can simply be thrown in and forgotten about.

app.use(new URLRouter());

A full example setup can be found in ./test.