https://github.com/clivern/x
🐺 A Lightweight And Powerful Control Panel, Set up in Minutes.
https://github.com/clivern/x
clivern control-panel linux-panel pilgrim
Last synced: 2 months ago
JSON representation
🐺 A Lightweight And Powerful Control Panel, Set up in Minutes.
- Host: GitHub
- URL: https://github.com/clivern/x
- Owner: Clivern
- License: mit
- Created: 2022-07-16T17:17:08.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-03T13:10:26.000Z (3 months ago)
- Last Synced: 2025-03-08T04:29:30.292Z (3 months ago)
- Topics: clivern, control-panel, linux-panel, pilgrim
- Language: Ruby
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
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:
```zsh
$ gem install bundler
$ make setup
```
To run the application:
```zsh
$ cp .env .env.local
# Then adjust .env.local
$ source .env.local
$ export $(cut -d= -f1 .env.local)
$ make run
```
To run test cases:
```zsh
$ make ci
```
To list all commands:
```zsh
$ make
```
## Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, Pilgrim is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.
See the [Releases section of our GitHub project](https://github.com/clivern/pilgrim/releases) 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]](mailto:[email protected])
## Contributing
We are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.
## License
© 2020, Clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).
**Pilgrim** is authored and maintained by [@clivern](http://github.com/clivern).