Skip to content
This repository has been archived by the owner on Sep 7, 2021. It is now read-only.
/ jungle-gym Public archive

JungleGym is a simple, user-friendly app for group teachers who have little or no expertise in physical education and have little material at their disposal.

License

Notifications You must be signed in to change notification settings

iamDistractech/jungle-gym

Repository files navigation

JungleGym - Meesterproef

Live link

Mockup

JungleGym is a simple, user-friendly app for group teachers who have little or no expertise in physical education and have little material at their disposal.

The app contains a list of all the different games that could be used during gym class. The teachers in Suriname can filter on different parts: the materials they have at their disposal, the number of students, the form of the game and the age category (group).

Production CI Development CI Netlify Status

GitHub issues GitHub closed pull requests GitHub last commit

GitHub tag (latest by date) GitHub repo size

Table of Contents

🤓 Course 🔗 Links ⚙️ Installation

🤓 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.

With the Meesterproef you show what you have learned during the minor. The final project is assessed on a Design rationale, a Product biography and a reflection on one's own level.

🔗 Links

CMS

The content (games) of the app are managed in a headless CMS (Strapi). The CMS repo contains all the code of this Content Management System.

API

The CMS API is patched by our own API. In this API are all the endpoints and is the authentication being managed. The API repo contains all the code of this API.

Design Rationale

The Design Rationale is an explicit documentation of the reasons behind the decisions we made. Besides that, it also contains the overall documentation about the app, like the tech stack and the user manual.

Product Biography

The individual Product Biographies can be found in the Wiki. In the Product Biography everyone keeps track of what they have done per week. You write about the process, the iterations, the working method and the planning.

⚙️ Installation

Prerequisites

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.

About

JungleGym is a simple, user-friendly app for group teachers who have little or no expertise in physical education and have little material at their disposal.

Topics

Resources

License

Stars

Watchers

Forks