givebloodorg / doesangue-core

Online platform that connects people interested in blood donation
https://givebloodorg.github.io
MIT License
87 stars 15 forks source link
api-server donations help-wanted laravel php social-network

Read about it here

Packagist All Contributors Build Status codecov Scrutinizer Code Quality Build Status Code Coverage

Topics.

What?

doesangue.me is a free (and opensource and free) platform that connects people interesting in blood donation.

Why?

Instalation

If you want to install locally or deploy to your server/infra please follow the guide at our Wiki

Development

Docker

docker-compose run app composer install # install php dependencies
docker-compose run app php artisan key:generate # generate the API_KEY
docker-compose run app php artisan migrate --seed # run the migrations
Artisan commands

Using the command docker-compose run app php artisan you can see all available artisan commands

Ex:

docker-compose run app php artisan # list the commands
docker-compose run app php artisan route:list # list all routes of our API

Service

By default the API run's in localhost:8080

docker-compose up # run's the service

To run the service in background:

docker-compose up -d # run's the service in background
docker-compose down # stop and kill the service

Contributing

To contribute to this repo, please check the documentation/guide at Contributing

Contributors

We consider and respect everybody that contribute to our project. Check the complete list of contributors in CONTRIBUTORS doc.