clivern / x Goto Github PK

Pilgrim

A Lightweight And Powerful Control Panel, Set up in Minutes.

Documentation

Getting Started

In order to run pilgrim, you need ruby >= 3.1.0 and nodejs. Then run the following commands:

$ gem install bundler

$ make setup

To run the application:

$ cp .env .env.local
# Then adjust .env.local
$ source .env.local
$ export $(cut -d= -f1 .env.local)

$ make run

To run test cases:

$ make ci

To list all commands:

$ make

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Pilgrim is maintained under the Semantic Versioning guidelines and release process is predictable and business-friendly.

See the Releases section of our GitHub project for changelogs for each release version of Pilgrim. It contains summaries of the most noteworthy changes made in each release.

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/clivern/pilgrim/issues

Security Issues

If you discover a security vulnerability within Pilgrim, please send an email to [email protected]

Contributing

We are an open source, community-driven project so please feel free to join us. see the contributing guidelines for more details.

License

© 2020, Clivern. Released under MIT License.

Pilgrim is authored and maintained by @clivern.