Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rinminase/anidb-be
💬🐳 Rin Minase's AniDB API Service utilizing the latest version of Laravel and deployed to Heroku
https://github.com/rinminase/anidb-be
anilist-api cloudinary docker functional-testing graphql heroku laravel open-api open-api-v3 php phpunit postgresql restful-api swagger web-scraping
Last synced: about 2 months ago
JSON representation
💬🐳 Rin Minase's AniDB API Service utilizing the latest version of Laravel and deployed to Heroku
- Host: GitHub
- URL: https://github.com/rinminase/anidb-be
- Owner: RinMinase
- License: isc
- Created: 2019-06-23T11:43:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-13T05:06:00.000Z (3 months ago)
- Last Synced: 2024-11-07T08:03:27.203Z (about 2 months ago)
- Topics: anilist-api, cloudinary, docker, functional-testing, graphql, heroku, laravel, open-api, open-api-v3, php, phpunit, postgresql, restful-api, swagger, web-scraping
- Language: PHP
- Homepage:
- Size: 2.39 MB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Rin Minase's Anime Database
(Back-end API Service)
## Introduction
_Add info here_
## Getting Started
### Environmental variables setup
> Note: You can disable specific modules
This is done by setting these specific ENV flags to true, to disable them.
```
DISABLE_SCRAPER - Disables WebScraper
```
1. Database
Definition of terms:
- **DB_CONNECTION** - the database configuration being used by Laravel
- **DATABASE_URL** - this is populated whenever an online database is being used
- **DB_HOST** - docker **container name** of the database
- **DB_PORT** - port used by the database
- **DB_DATABASE** - database username
- **DB_PASSWORD** - database password
These are the configuration options for the database:
```
DB_CONNECTION=pgsql
DATABASE_URL=
DB_HOST=anidb-pgsql
DB_PORT=5432
DB_DATABASE=anidb
DB_USERNAME=postgres
DB_PASSWORD=postgres
```
**Notes :** DB_HOST **should** use docker container name of db, by default this is 'anidb-pgsql', but yours could be different. You can check this by running `docker ps` then check the container name of the `postgres` container.
2. Cloudinary
- Fire up your browser and login your [Cloudinary Account](https://cloudinary.com/users/login). If you have no account yet, you can [create one](https://cloudinary.com/users/register/free) for free.
- After logging in, navigate to the [Cloudinary Console](https://cloudinary.com/console) to retrieve your Cloudinary URL
- Copy the value of `API Environment variable` to `CLOUDINARY_URL` of your ENV file
### Running the project
1. [Download](https://www.docker.com/products/docker-desktop) and install `Docker for Windows`.
2. Clone the project, then install the dependencies
```
git clone https://github.com/RinMinase/anidb-be.git
cd anidb-be
```
3. Run the necessary docker containers
```
docker-compose up -d
docker-compose exec php sh
```
4. Inside the docker image, copy the env file, install the necessary dependencies and generate the API Key
```
cp .env.example .env
composer install
php artisan key:generate
```
5. Modify the ENV file with the **necessary configuration values**
6. Clear the Laravel config cache, then run the database migrations
```
php artisan config:clear
php artisan migrate:fresh --seed
```
6. Fire up your browser and go to `localhost`.
**Note:**
If you need to access the container run, `docker-compose exec php bash`
### Re-running the project
1. Navigate to the project foler root then run `docker-compose up -d`
2. Run the migrations when necessary, then install the dependencies also when necessary
```
php artisan migrate
composer install
```
3. Fire up your browser and go to `localhost`.
### Running the Swagger Generator / API Documentation Generator
1. Navigate to the project foler root then run `docker-compose up -d`
2. Run the command below:
```
composer docs
```
3. Fire up your browser and go to `localhost/docs` to open Swagger UI.
### Running the Unit Tests
1. Navigate to the project foler root then run `docker-compose up -d`
2. Run the command below:
```
php artisan test
```
or if you want to run a specific test module
```
php artisan test --filter
```
or if you want to run a specific single test
```
php artisan test --filter test_function_name tests/Location/of/TestCase.php
```
### Project shorthands / aliases inside the PHP Docker container
This shortcuts were created to reduce the need to keep typing the same long commands over and over again.
| Shortcut | Long version |
| ----------------- | ----------------------- |
| `pa` or `artisan` | `php artisan` |
| `docs` | `composer docs` |
| `dump` or `da` | `composer dumpautoload` |
### Project Structure
.
├── app/ # Application source code
│ ├── docs.blade.php # Swagger page template
│ ├── index.blade.php # Landing page template
│ └── ... # Other application-related files
├── bootstrap/ # Project initializers
│ ├── app.php # Framework bootstrapper
│ ├── helpers.php # Helper functions
│ └── routes.php # Route definitions
├── config/ # Laravel configuration files
├── database/ # Database migrations and seeders
├── docker/ # Docker functions
│ ├── php-config/ # PHP settings for docker
│ ├── sites/ # Nginx sites for docker
│ ├── nginx.dockerfile # Nginx container docker file
│ ├── php.dockerfile # PHP container docker file
│ └── ... # Other docker files
├── public/ # Project entry point
├── tests/ # Project test files
├── .czrc # Commitizen configuration file
├── docker-compose.yml # Main docker file
├── phpunit.xml # Unit test configuration file
├── Procfile # Heroku process file
└── ... # Other project files
## Built with
* 
[Laravel 11](https://laravel.com) - Core Framework
* 
[PHP 8.3](https://php.net) - Language syntax
* 
[PostgreSQL](https://www.postgresql.org) - Database
* 
[Docker](https://www.docker.com) - Container platform
* 
[Swagger](https://swagger.io/) - API Documentation
* 
[Heroku](https://www.heroku.com) - Hosting and Continuous Integration (CI) service
* 
[PHPUnit](https://phpunit.de/) - Unit Testing
* 
[RESTful API](https://restfulapi.net) - HTTP Requests Architecture
## Deployed to
* [Heroku](http://rin-anidb.herokuapp.com)