fisicus is a cli tool that allows seo analysts to filter a target sitemap with a desired pattern.
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.
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 OSmachine with working knowledge of the underlying filesystem and Go build process.
- 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
-
Check the run configuration in
fisicus.sh. AdjustSITEMAPandFILTERif necessary. -
Run
make initinside the directory. This is going to resolve the required Go dependencies, build and run the application. -
The fisicus web service should now be served under
:8080/sitemap. -
While the web service is running, you can overwrite the specified configs with the request params
sitemapandfilterwithin that request at any moment. ** Example:**:8080/sitemap?filter=/home/about/*&sitemap=https://yourwebsite.com/sitemaps/sitemap.xml
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.
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.
There is also a Dockerfile by which one can containerize the stapagen application. The port that is being exposed is the default 8080.
{coming soon}
To contribute to gostapafor, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git commit -m '<commit_message>' - Push to the original branch:
git push origin <project_name>/<location> - Create the pull request.
Alternatively see the GitHub documentation on creating a pull request .
Thanks to the following people who have contributed to this project:
- @raffaelschneider 💻📖🐛
- @stefanwelsch 💻🧑🏫
- @tomtrapp 🤔👀
- @rickyelfner 💬🐛
You might want to consider using something like the All Contributors specification and its emoji key.
If you want to contact us you can reach us at [email protected].
No license has been applied yet.