Skip to content

amalv/bukie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bukie

Maintainability Test Coverage Code Climate Status Deploy Status Semantic Release Status TypeScript React Apollo Client Auth0 Vite Bun Playwright

Bukie is a project showcasing the use of TypeScript, React, Emotion, Material UI, and Apollo Client in a real-world application. It features a curated list of science fiction books, with a search engine and filters by title and author for easy navigation.

The application supports both light and dark themes, adapting to user browser preference, and offers infinite scrolling on the book list. User authentication is handled via Auth0.

The project leverages Semantic Release for automated versioning and releases, and Biome for code format and linting. It also benefits from the fast development and build times provided by Vite.

⚠️ This project is the companion to a backend project, which is an Apollo Server project that uses serverless, AWS Lambda, and Postgres as a database. The backend project must be launched first for local development. You can find it here.

Screenshot

Showcase Image

Features

📚 Curated list of science fiction books

🎛️ Filters by title and author

🚀 Built with TypeScript and React

💅 Styled with Emotion and Material UI design system

🌓 Supports light and dark themes (defaults to user browser preference)

📜 Infinite scrolling on the book list

🔒 User authentication via Auth0

🚦 Automated versioning and releases with Semantic Release

🔧 Code linting and formatting with Biome

🚀 Fast development and build times with Vite

📡 Data fetching with Apollo Client

Getting Started

⚠️ To get started with the project, you must first launch the backend project. You can find it here.

Then, follow these steps:

Clone the repository:

git clone git@github.com:amalv/bukie.git

Install the dependencies:

npm install

Update the .env.sample file with your environment variables:

VITE_API_URL_DEVELOPMENT= # Usually http://localhost:3000 from the companion project
VITE_AUTH0_DOMAIN=
VITE_AUTH0_CLIENT_ID=

Rename the .env.sample to .env

Start the development server:

npm run dev

License

This project is licensed under the MIT License.

About

A showcase project for curated books

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages