Skip to content

Latest commit

 

History

History
121 lines (95 loc) · 3.81 KB

README.md

File metadata and controls

121 lines (95 loc) · 3.81 KB

Thoth 2.0

Latest Stable Version PHP Version Require

Systematic Literature Review Tool

Technologies and Tools

Understanding the Framework Structure

  1. Laravel DOC - https://laravel.com/docs/10.x
  2. Understanding the structure - https://www.youtube.com/watch?v=zN0gAqOcxsk

Suggested Bootstrap Template

Information on how to use the template elements https://argon-dashboard-laravel.creative-tim.com/docs/bootstrap/overview/argon-dashboard/

Step-by-Step Initial Setup

Clone the Repository

git clone -b https://github.com/Thoth2023/thoth-remake.git

Create the .env File

cp .env.example .env

Start the Project Containers

docker-compose up -d

Access the App Container

docker-compose exec app bash

Install Project Dependencies

composer install

If there are any errors during dependency installation

composer update

Generate the Laravel Project Key

php artisan key:generate

To Populate the Database

php artisan migrate --seed
For development, create a new branch from "Develop"

Access the Project

http://localhost:8989

Make Shortcuts

# Start Docker in the Background
up:
    docker-compose up -d

# Shut Down the Containers
down:
	docker-compose down

# Restart the Containers
restart:
	docker-compose restart

# Show Logs
logs:
	docker-compose logs -f

# Show Container Status and All Containers
ps:
	docker-compose ps -a

# Inside the Container, Install Composer Dependencies and Generate the Key (To access the container, use the command: docker-compose exec app bash)
setup:
	composer install || composer update
	php artisan key:generate
	php artisan migrate --seed

If needed, visit https://www.gnu.org/software/make/ for more details.

To use make:

  • Access the project directory
  • Open the terminal/console
  • Type make (command)

Example: To list the containers, run

make ps

To install the project dependencies, you can access the container with

docker-compose exec app bash

And inside the container, run

make setup

Access the Project

http://localhost:8989