EmJee1/CHE-FDD-assignment

Interactive powerpoint-like website for school project

CHE FDD Assignment

This is a project made for a CHE assignment (university of applied sciences).

The repo contains the public website & backend for the CHE FDD assignment I made. The website is made with Nuxt 3 and for the back-end we use Firebase Cloud Functions with Firestore.

✨ See it in action ✨

Environment	Web
CHE hosting	View
Firebase hosting	View

🧰 External tooling

• Figma for the designs
• Firebase for the backend

🚀 Getting started

Prerequisites

• WebStorm or Visual Studio Code
• Node Version Manager (Mac | Windows)

Installation

• Use correct node version

nvm use

• Install packages in /, /client & /functions

npm i && cd client && npm i && cd ../functions && npm i

Development

• Run the client

cd client
npm run dev

• To run functions locally, run

cd functions
npm run serve

# to enable automatic reloading for functions, do the following in a separate tab
cd functions
npm run build:watch

Deployment / Release process

Github Actions are used for automatic code-checking & deployment.

• If client build succeeds -> deploy to Amazon S3 & Firebase Hosting
• Functions are checked for linting & typescript but are not deployed automatically
• To deploy functions, run npm run deploy in the functions directory

🤚 Good to know

• We use Dependabot for automatic package updates
• This creates pull requests every monday, for all npm packages that are outdated