https://github.com/tobiaslueger/shamrock

A Website for Shamrock an irish pub in Rheinbach
https://github.com/tobiaslueger/shamrock

contentful nextjs tailwindcss typescript

Last synced: 4 months ago
JSON representation

A Website for Shamrock an irish pub in Rheinbach

• Host: GitHub
• URL: https://github.com/tobiaslueger/shamrock
• Owner: TobiasLueger
• Created: 2023-11-09T18:42:33.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-24T10:11:33.000Z (4 months ago)
• Last Synced: 2024-10-15T17:37:12.009Z (4 months ago)
• Topics: contentful, nextjs, tailwindcss, typescript
• Language: TypeScript
• Homepage: https://shamrock.vercel.app
• Size: 1.23 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Shamrock Irish Pub - Next.js App Documentation

This documentation describes the structure and functionalities of the Shamrock Irish Pub website, built using Next.js.

### Inputs

* The app utilizes CSS variables for styling, defining core colors and fonts. These can be adjusted in the `src/app/globals.css` file.

* Storybook is used for component development and documentation, with a focus on accessibility. Stories are defined in files with the `.stories.tsx` extension.

### Outputs

* The app renders a single page with a hero section showcasing the pub's information, and a following section with information about the team. 

* Navigation is implemented as a fixed element on the top of the page, and hides on scrolling down, revealing itself again on scrolling up.

* The app is responsive and designed using Tailwind CSS.

### Usage

This application serves as a simple website for the Shamrock Irish Pub. It provides basic information about the pub, its team, and current events. Users can navigate through the different sections of the website via the fixed navigation bar.

**Storybook**

Storybook is a powerful tool that enables developers to build and test components in isolation. It also serves as a documentation tool by showcasing each component's functionalities and available props.