Skip to content

Commit

Permalink
📖 DOC: improve Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yoanbernabeu committed Mar 20, 2022
1 parent ce0ff0b commit 423e73e
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 2 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ install: export APP_ENV=dev
install:
docker-compose up -d
composer install
symfony serve -d
npm install
npm run build
symfony console d:d:c
Expand Down
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,56 @@
# Cronify

Simply monitor your Cron

[![Pipeline-CI](https://github.com/yoanbernabeu/cronify/actions/workflows/ci.yml/badge.svg)](https://github.com/yoanbernabeu/cronify/actions/workflows/ci.yml)
[![Pipeline-CI](https://github.com/yoanbernabeu/cronify/actions/workflows/ci.yml/badge.svg)](https://github.com/yoanbernabeu/cronify/actions/workflows/ci.yml) [![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](LICENSE)


![Pipeline-CI](public/img/logo_ban.png)

---

## 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.
2 changes: 1 addition & 1 deletion tests/Repository/UserRepositoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
use App\Repository\UserRepository;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;

class UserpRepositoryTest extends KernelTestCase
class UserRepositoryTest extends KernelTestCase
{
public function testShouldBeCreateNewUser(): void
{
Expand Down

0 comments on commit 423e73e

Please sign in to comment.