https://github.com/2hgo/checkdc_assessment
https://github.com/2hgo/checkdc_assessment
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/2hgo/checkdc_assessment
- Owner: 2HgO
- Created: 2024-01-28T12:24:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-28T22:41:20.000Z (over 2 years ago)
- Last Synced: 2025-10-31T12:02:11.819Z (8 months ago)
- Language: PHP
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CheckDC Assessment
## Requirements
- php v8.0.0+
- docker v24.0.0+
- GNU Make v3.81+
- Composer v2.0.0+
## Run
to run the application, create a `.env` file using the [sample env file](.env.example) and run the following command:
```bash
make dev
```
this runs 3 recipes
- app: to start up the http server
- queue_worker: to start up queue workers that process the jobs that process the different item types
- scheduler: that handles the twice daily data spooling
## Docs
To view the documentation for this application's endpoints, import the [documentation file](docs/api.raml) into your documentation tool of choice
## Data
to seed the database with data, run the following command
```bash
make seed
```