Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kimchanhyung98 committed Jun 19, 2024
1 parent b054486 commit 2937912
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .env.testing
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Application
APP_NAME=Laravel
APP_ENV=local
APP_KEY=base64:D6auxZFtaJfTk/sjZDMV07kBb//bg/TOuWDSInFLlwg=
APP_KEY=
APP_DEBUG=true
APP_TIMEZONE=Asia/Seoul
APP_URL=http://localhost
Expand Down
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
# laravel starter kit

필요한 최소한의 기능을 구현해놓은 템플릿입니다.
[Sail](https://laravel.com/docs/10.x/sail)을 사용하여 실행할 수 있습니다.

- PHP 8.3 & Laravel 11
- Redis
- AWS ECR, EB, S3
- [next-starter-kit](https://github.com/LeeByeongMuk/next-starter-kit)
PHP 8.3 & Laravel 11.x를 사용한 최소 기능(User, Post, Comment, Like)을 구현한 템플릿입니다.

## Install

[Sail](https://laravel.com/docs/10.x/sail)을 사용하여 실행할 수 있습니다.
(배포는 AWS ECR, EB를 사용합니다)

```bash
brew install [email protected] composer
composer install
sail up # or ./vendor/bin/sail up
sail artisan migrate --seed
sail artisan scout:import "App\Models\Post"
brew install [email protected] composer && composer install
cp .env.example .env && php artisan key:generate && php artisan key:generate --env=testing

./vendor/bin/sail up -d # 최초 실행시 약 10분 소요
./vendor/bin/sail artisan migrate --seed
./vendor/bin/sail artisan scout:import "App\Models\Post"
# ./vendor/bin/sail artisan test
```

## OpenAPI

Scramble - Laravel OpenAPI(Swagger) Generator 를 사용하여 API 문서를 확인할 수 있습니다.
- localhost/docs/api

- [localhost/docs/api](http://localhost/docs/api)

### FE

- [next-starter-kit](https://github.com/LeeByeongMuk/next-starter-kit)

0 comments on commit 2937912

Please sign in to comment.