sumer5020/nuxt-laravelapi-starter-kit

Ready to go Laravel web api and nuxt3 template 🔥

Starter Kit for Laravel and Nuxt3

An Open Source Project designed to provide our fellow developers/students a better way to get started.

Content

Project	Type	Description
api.app	Laravel 11	Required. PHP ^8.2
app	Nuxt 3	Required. Node ^v20.14

Features

• api.app

  • Laravel breeze api
  • Http response helper
  • Activity log helper
  • Collection manager helper
  • Htaccess firewall

• app

  • Tailwind CSS
  • Responsive design
  • Light/dark mode component
  • Multilingual component
  • Auth pages
  • Dashboard
  • Toast notification

Setup And Run

Test the app by run the following command:

  # API
  composer install --working-dir=./api.app
  php ./api.app/artisan migrate
  php ./api.app/artisan db:seed
  php ./api.app/artisan serve

  # WEB
  yarn --cwd ./app install
  yarn --cwd ./app run dev

Feedback

If you have any feedback, please reach out to us at [email protected]

nuxt-laravelapi-starter-kit's Issues

User Dashboard

Story:

As a customer, I want to be able to show and manage my account data and information throw an account dashboard

Technical Hints:

Create a REST point to allow user to show his account data and information and create its related UI

Acceptance Criteria:

• A customer can show a dashboard only if the user successfully login
• Should show charts and analytics information as a section in a default dashboard
• A responsive UI design
• Dashboard should have header section contain search input field and notification button
• Dashboard should have side section contain user info [name, email and the first character of the name as an image]
• Dashboard side should have links with icons for the main parts of a dashboard and sub-links for the secondary parts
• Dashboard side should have footer part contain [logout, language changer and theme changer] iconic buttons
• Should handle errors and show related error messages
• A responsive UI design

Login to an account

Story:

As a customer, I want to be able to sign in to my account

Technical Hints:

Create a REST point to allow user login to his account
Following fields are required (email, password) and create a related UI

Acceptance Criteria:

• A customer can log in to his account in secure way
• All fields are required
• Should return an error message when credentials not correct
• Should show reactive error messages
• A responsive UI design

Index page

Story:

As a customer, I want to be able to show the necessary and highlight sections and information in the root URL

Technical Hints:

Create a REST point to show the necessary and highlight sections information and create the related UI

Acceptance Criteria:

• Should have hero section
• Should have header section that contain [logo, links list, language changer and theme changer]
• Should have footer section that contain [MIT, logo, most used links list, related links list, contact info and social media links]
• A responsive UI design

Register new account

Story:

As a customer, I want to be able to register a new account

Technical Hints:

Create a REST point to allow user registration
Following fields required (email, password, name) and create its related UI

Acceptance Criteria:

• A customer can register a new account with mentioned fields
• All fields are required
• Should return an error message if the email already exists
• Should handle missing fields and return an error messages
• A responsive UI design