Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tcampbppu/punchbook
Laravel + Nuxt Example Project
https://github.com/tcampbppu/punchbook
laravel nuxt typescript vue windicss
Last synced: 2 months ago
JSON representation
Laravel + Nuxt Example Project
- Host: GitHub
- URL: https://github.com/tcampbppu/punchbook
- Owner: tcampbPPU
- Created: 2021-12-07T02:39:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-31T06:20:55.000Z (11 months ago)
- Last Synced: 2024-10-17T19:03:04.538Z (3 months ago)
- Topics: laravel, nuxt, typescript, vue, windicss
- Language: PHP
- Homepage:
- Size: 5.33 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## PunchBook
Application to create simple contacts with name, phone, email.
## Technologies
### API
* PHP 8.1
* Laravel 9
### Frontend
* Nuxtjs 3
* Typescript
* Vuejs 3
* WindiCSS
### Devops
Application is deployed serverless using AWS Lambda
API is using Vapor
Frontend is using Fume
## Installation
There are 2 main options of building application locally
1. Using local services - php, yarn, mysql, node
2. VS Code remote containers - VSCode, Docker * Docker Compose
clone from GitHub
run yarn and composer install to install all of your deps
copy .env.example to .env and configure it to your likings
TL;DR
```bash
git clone [email protected]:tcampbPPU/punchbook.git; cd punchbook; yarn; composer install; cp .env.example .env;
```
### Option 1 (Local)
#### Requirements
* PHP 8.1
* Composer - version 2
* Nodejs - version 16.11.0
* Yarn
* MySQL
### Option 2 (VS Code)
#### Requirements
* VSCode
* docker
* docker-compose
1. Install VS Code Remote Dev Extension
[Extension](https://aka.ms/vscode-remote/download/extension)
2. Open Command Paletter (F1) and select *Remote-Containers: Open Folder in Container...*
3. Wait for all containers to start
## Once Setup:
After you have ran install for dependencies (`composer install` && `yarn`)
Run:
```bash
yarn seed
```
This will run DB migrations and set some faker data.
#### Starting Services
run `yarn dev` in one terminal for our nuxt dev setup
run `yarn api` (alias for ./artisan serve) in another terminal for our laravel API
`localhost:8000` will be api
`localhost:3000` will be frontend
## TESTS
API is tested with PHPUnit can run
```
composer test
```
### Extras
Can either setup OAuth token with Google or Github and set the ID and secret
```
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
```
```
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
```