Skip to content

fisicus is a tool that applies pattern matching to a target sitemap and forwards it.

License

Notifications You must be signed in to change notification settings

b-nova-openhub/filter-sitemap-customizer

Repository files navigation

fisicus-header

gofisicus (go-filter-sitemap-customizer)

GoDoc GitHub repo size GitHub contributors GitHub stars GitHub forks Twitter Follow

fisicus is a cli tool that allows seo analysts to filter a target sitemap with a desired pattern.

About

With our b-nova collection of microservices, we're offering a complete set of modules which enables our JAMstack. fisicus is an important module as it reads and forwards a customized sitemap from a given website.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of go1.16.5
  • You have a Linux/Mac OS machine with working knowledge of the underlying filesystem and Go build process.

Installation

  1. Download and extract fisicus to your web directory or get the latest development version with:
$ ❯  git clone https://github.com/b-nova-openhub/filter-sitemap-customizer
  1. Check the run configuration in fisicus.sh. Adjust SITEMAP and FILTER if necessary.

  2. Run make init inside the directory. This is going to resolve the required Go dependencies, build and run the application.

  3. The fisicus web service should now be served under :8080/sitemap.

  4. While the web service is running, you can overwrite the specified configs with the request params sitemap and filter within that request at any moment. ** Example:** :8080/sitemap?filter=/home/about/*&sitemap=https://yourwebsite.com/sitemaps/sitemap.xml

Build

You can build fisicus with the provided Makefile. In order to do so, execute following command in the projects root directory.

$ ❯  make all

🔰: If you're building for the first time and jumped ahead of this README, replace make all with make init.

Usage

fisicus – a service that applies pattern matching to a target sitemap

Usage:
fisicus [command]

Available Commands:
serve Serve serve service and its rest endpoints
completion generate the autocompletion script for the specified shell 
help Help about any command 

Flags:
-h, --help help for jamctl

Use "fisicus [command] --help" for more information about a command.

Dockerfile

There is also a Dockerfile by which one can containerize the stapagen application. The port that is being exposed is the default 8080.

Deployment to K8s

{coming soon}

Quick Deployment to DigitalOcean's Kubernetes

Deploy to DO

Contributing to gofisicus

To contribute to gostapafor, follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin <project_name>/<location>
  5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request .

Contributors

Thanks to the following people who have contributed to this project:

You might want to consider using something like the All Contributors specification and its emoji key.

Contact

If you want to contact us you can reach us at [email protected].

License

No license has been applied yet.