Skip to content

Stars Wars API explorer. Built with Laravel + React.

Notifications You must be signed in to change notification settings

thenameisflic/sw-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SWStarter

SWStarter is a Star Wars API explorer built with Laravel (backend) and React (frontend). It allows users to search for Star Wars characters (people) and movies, and view detailed information about them. It is designed to be user-friendly, responsive, and efficient.

Additional Features

Besides basic search features and exploring details of records, some features I'd like to highlight are:

1. Responsive design

I've leveraged TailwindCSS to design for a varied set of screen sizes, which include mobile devices.

image

2. Dark mode support

The UI will automatically adapt to your system's preferences. If your device is set to Dark Mode, the application will switch to a dark theme.

image

3. Basic animations

The UI incorporates subtle animations powered by motion. They are designed to make interactions smoother, more engaging and visually appealing without getting in the way.

Peek 2025-03-02 19-20

4. Cached responses

To improve performance and reduce redundant API calls, nested API records are cached.

5. Query statistics

The application includes a /statistics endpoint that provides insights into query usage and response times. Statistics are computed immediately on the first access and subsequently updated every 5 minutes.

image

Getting Started

Prerequisites

The setup has been tested with MacOS 15 and Debian 12.

Debian Docker Setup MacOS Docker Setup
image remmina_Quick Connect_51 159 121 111:59010_20250302-221155
  1. Docker: Ensure Docker is installed on your machine.
  2. Ports: Make sure ports 8000 (backend) and 5173 (frontend) are available on your host machine.

Running the Application with Docker

  1. Clone the repository to your local machine.

  2. Navigate to the project folder in your terminal.

  3. Run the following command to start the application: docker compose up

  4. Once the containers are up and running, open your browser and navigate to: http://localhost:8000

Notes on Docker Setup

The provided Dockerfile and docker-compose configuration are intended for demo purposes only. They are not optimized for production or development environments. For maximum compatibility, we don't use volumes.

About

Stars Wars API explorer. Built with Laravel + React.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published