JungleGym - Meesterproef

Live link

API repo can be found here

CMS repo can be found here

[Insert JungleGym project description]

Table of Contents

🤓 Course

👓 Overview

⚙️ Installation

🗂 Folder Structure

💢 Others

🤓 Course

The Meesterproef is the final client-project of the half year minor programme about Web Design and Development in Amsterdam. Bachelor Communication and Multimedia Design, Amsterdam University of Applied Science.

👓 Overview

Screenshot

Homepagina

Overzichtspagina

⚙️ Installation

Prerequisites

• Redis database for session storage
  • What is a session storage?
  • Local session storage with docker

Developing

Everything you need to build a Svelte project, powered by create-svelte;

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

Before creating a production version of your app, install an adapter for your target environment. Then:

npm run build

You can preview the built app with npm run preview, regardless of whether you installed an adapter. This should not be used to serve your app in production.

Environment Variables

Copy the .env.example and rename it to .env.

Husky

Husky is used to format your code (automatically) on commit.

In order to use Husky you have to install it with npm run prepare. This will install Husky for your project.

The next time you commit, Husky will automatically format it for you.

📂 Folder Structure

# GitHub files
|.github

# Broncode van het project
|-src

	# Library met eigen components
	|-lib

	# Alle (file-based) routes
	|-routes

# Alle static files
|-static

We zijn het er nog niet helemaal over eens of we het zo willen gaan doen. Wellicht dat we dit in de Design Rationale gooien. Heeft niet echt een toegevoegde waarde in de README.

💢 Others

Design Rationale (will be added later)

Als we de documentatie een eind af hebben, komen hier ook andere links. Zo leggen wij uit waarom er een CMS is. Wat daar gedaan wordt. Hoe de API werkt etc. Dit hebben wij nog niet af, dus daarom is dat nog niet toegevoegd.