forked from yoanbernabeu/Cronify
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ce0ff0b
commit 423e73e
Showing
3 changed files
with
53 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,56 @@ | ||
# Cronify | ||
|
||
Simply monitor your Cron | ||
|
||
[](https://github.com/yoanbernabeu/cronify/actions/workflows/ci.yml) | ||
[](https://github.com/yoanbernabeu/cronify/actions/workflows/ci.yml) [](LICENSE) | ||
|
||
|
||
 | ||
|
||
--- | ||
|
||
## What is cronify ? | ||
|
||
Cronify is a simple tool to monitor the execution of your cron jobs. | ||
|
||
The use is super simple: | ||
1. Declare one or more applications | ||
2. Declare one or more jobs for your applications | ||
3. For each job, you only have to touch three addresses to log the execution: | ||
- An address to start a cron | ||
- An address to stop a cron | ||
- An address to indicate an error | ||
|
||
## How to install the app ? | ||
|
||
Cronify is a simple Symfony/PHP/PostgreSQL application. | ||
|
||
This documentation offers a simplified installation FOR DEVELOPMENT ONLY with Docker. You can do without it if you already have PostgreSQL. | ||
|
||
### Prerequisites | ||
|
||
- [PHP 8.1](https://www.php.net/downloads.php) | ||
- [Composer](https://getcomposer.org/) | ||
- [Docker](https://www.docker.com/) | ||
- [Make](https://www.gnu.org/software/make/) | ||
- [Symfony CLI](https://symfony.com/download) | ||
|
||
### Clone and install | ||
|
||
```bash | ||
git clone https://github.com/yoanbernabeu/Cronify.git | ||
cd Cronify | ||
make install | ||
``` | ||
|
||
### Create a new User | ||
|
||
User creation is possible from the command line. | ||
|
||
```bash | ||
symfony console app:create-user [email protected] password | ||
``` | ||
|
||
## License | ||
|
||
See the bundled [LICENSE](LICENCE) file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters