Add info here

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. If you have no account yet, you can create one for free.
   • After logging in, navigate to the Cloudinary Console to retrieve your Cloudinary URL
   • Copy the value of API Environment variable to CLOUDINARY_URL of your ENV file

1. Download 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
   

7. Fire up your browser and go to localhost.

Note: If you need to access the container run, docker-compose exec php bash

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.

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.

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 <Class Name of Test File>
   

   or if you want to run a specific single test

   php artisan test --filter test_function_name tests/Location/of/TestCase.php
   

This shortcuts were created to reduce the need to keep typing the same long commands over and over again.

.
├── 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

• Laravel 11 - Core Framework
• PHP 8.3 - Language syntax
• PostgreSQL - Database
• Docker - Container platform
• Swagger - API Documentation
• Heroku - Hosting and Continuous Integration (CI) service
• PHPUnit - Unit Testing
• RESTful API - HTTP Requests Architecture

• Heroku