1
0
Fork 0
forked from Kispi/Core
HGÖ Schule als Staat Software 2023
Find a file
2022-07-28 16:46:07 +02:00
.docs feat(core): initial commit 2022-07-12 20:44:26 +02:00
.vscode feat(core): initial commit 2022-07-12 20:44:26 +02:00
public feat(core): initial commit 2022-07-12 20:44:26 +02:00
src feat(webapp): add account modal functionality 2022-07-28 16:46:07 +02:00
.drone.yml feat(core): initial commit 2022-07-12 20:44:26 +02:00
.eslintrc.js feat(core): initial commit 2022-07-12 20:44:26 +02:00
.gitignore feat(core): initial commit 2022-07-12 20:44:26 +02:00
COMMIT_CONVENTION.md feat(core): initial commit 2022-07-12 20:44:26 +02:00
Dockerfile feat(core): initial commit 2022-07-12 20:44:26 +02:00
index.html feat(core): initial commit 2022-07-12 20:44:26 +02:00
package.json feat(webapp): add appwrite 2022-07-26 16:24:22 +02:00
pnpm-lock.yaml feat(webapp): add appwrite 2022-07-26 16:24:22 +02:00
postcss.config.js feat(core): initial commit 2022-07-12 20:44:26 +02:00
README.md feat(core): initial commit 2022-07-12 20:44:26 +02:00
tailwind.config.js feat(core): initial commit 2022-07-12 20:44:26 +02:00
tsconfig.json feat(core): initial commit 2022-07-12 20:44:26 +02:00
tsconfig.node.json feat(core): initial commit 2022-07-12 20:44:26 +02:00
vite.config.ts feat(core): initial commit 2022-07-12 20:44:26 +02:00

🔥 Core - Kinderspielstadt Öhringen 🔥

Verwaltung + Bank + Radio = ❤️

screenshot

This is our repository containing all required resources to run the "Core" WebApp from the "Kinderspielstadt Öhringen".
This repository also contains all the required Appwrite cloud functions if any exist.

🚀 Getting Started

The following instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
See deployment for notes on how to deploy the project on a live system.

🍽️ Prerequisites

NodeJS (including PNPM) is required to run this project.
Also a hosted instance of Appwrite is required.

📦 Installing

At first clone this repository to your local machine by using

git clone https://git.cliffbreak.de/Kontast/Core.git

Change to the cloned repository

cd Core

To install all required packages run

pnpm install

To start the webapp in development mode run the following npm script

pnpm run dev

🧑‍💻 Configure Visual Studio Code

If you haven't a instance of Visual Studio Code up and running download the latest version here.
Install the recommended extensions by opening the Extensions-Tab (Ctrl+Shift+X).
Enter @recommended and install all extensions.
After that restart Visual Studio Code to apply all changes.

🎉 Contributing

Please refer to our COMMIT_CONVENTION

🏗️ Built With

  • Node.js - The JavaScript runtime used as the projects base
  • PNPM - Faster alternative to npm for managing dependencies
  • Vue.js - The Frontend Web Framework
  • Vite - Used Frontend Tooling
  • Appwrite - The hosted Backend used for this application

🤵 Authors