Requirements

• Windows with WSL2 or any Linux distro
• Docker
• Composer installed globally
• Configured SSH key

Getting Started

1. Clone the repository

git clone git@github.com:lebkowskih/articles.git

2. Navigate to the project directory

cd articles

3. Install dependencies

composer install

4. Copy the .env.example file to .env

cp .env.example .env

5. Set database variables in .env

DB_DATABASE=articles DB_USERNAME=sail DB_PASSWORD=password

6. Generate application key:

php artisan key:generate

7. Start the Docker containers using Laravel Sail

./vendor/bin/sail up -d

8. Migrate all database and seed all data

./vendor/bin/sail php artisan migrate:fresh --seed

9. Install and start Vite

./vendor/bin/sail npm install && ./vendor/bin/sail npm run dev

10. Access application at http://localhost

Endpoints

Method	URL	Description
GET	/api/articles/1	Retrieve post #1
GET	/api/articles/author/{authorId}	Retrieve all posts created by author with id #1
GET	/api/authors/top-authors	Retrieve top 3 authors that wrote the most articles last week.