S3ak/golden-egg-2024-next

Noroff Golden Egg Awards website for nominating submissions and getting tickets for the physical event. https://s3ak.github.io/golden-egg-2024-next/

3# Golden Egg 2024: Celebrating Student Talent

Welcome to the Golden Egg 2024, the prestigious awards ceremony where we celebrate the outstanding talent and creativity of Noroff students from across Norway. This annual event is the culmination of a year of hard work and dedication, showcasing the diverse range of skills and achievements within our community

This is a Next.js project bootstrapped with create-next-app.

Project Assets

• Storybook | Component Library
• Storybook | Component Library via github pages
• Storybook | Deployment dashboard
• Teams Comms Channel
• Production deploy
• Wordpress Production deploy
• Staging deploy
• Deployment Dashboard
• Last years website
• Last year code repo
• Design Doc
• Lo-Fi Design Spec
• Hi-Fi Design Spec
• API URL
• Analytics dashboard
• Payment Service Docs (Billetto)

Tech Stack

• Next.js
• TypeScript
• Vipps
• Tailwind CSS
• Framer Motion
• Storybook
• Cypress
• Luxon
• React Hook Form
• Zod
• React Icons
• Aceternity UI
• AutoAnimate
• Superbase
• Zustand
• NextAuth.js
• Prettier - An opinionated code formatter
• Eslint - Find and fix problems in your JavaScript code
• MS Teams Forms

Resources

• Typescript cheatsheet

Project leads

• Monde Sineke: nkululeko.sineke@noroff.no - Technical lead
• Bent Kjetil Laerum: bent.kjetil.laerum@noroff.no - Event lead
• Emily Mellem: emily.mellem@noroff.no - Design Lead

Features

• Build components in isolation with Hot Module Replacement
• SEO friendly #TODO
• Responsive #TODO
• Easy animations #TODO
• Prebuilt components #TODO
• Easy validation with Hook Form & Zod #TODO
• Easy backend integration with Superbase #TODO
• E2E testing with every pull request #TODO
• Simple State management with Zustand #TODO

Enviroments

There are two enviroments.Pr

production

Production is the enviromewnt the end-user experience. This is the final product that will be deployed to the public. This enviroment is hosted on Vercel.

staging

Staging is the enviroment where the team can test the latest features and bug fixes. This enviroment is hosted on Vercel.

Getting Started

Quick Start

• Checkout using VScode
• press F1 and type git:clone
• Install packages
• press F1 and type run task and hit enter.
• type npm and hit enter.
• type install and hit enter.
• press F5

1 Install all the dependencies:

npm install

2 Checkout from staging to a new branch:

git checkout -b feature/your-name-feature

3 run the development server:

npm run dev

Forth. Open up cypress to see that you have not broken anything:

npm run test:e2e:open

Fifth. Open up storybook to start developing your component:

npm run storybook

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Minimum acceptence criteria

Please see issues tab.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.