This is our repository containing all required resources to run the "Core" WebApp from the "Kinderspielstadt Öhringen".
This repository also contains all the required Pocketbase files to run the backend server.
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.
NodeJS (including PNPM) is required to run this project.
Also Go is required to run the built in server.
At first clone this repository to your local machine.
Change to the cloned repository
cd Core
Copy the example environment file
cp .env.example .env
To install all required webapp packages run
cd webapp && pnpm install
To start the webapp in development mode run the following npm script
pnpm dev
To build the webapp run the following npm script
pnpm build
To install all required server packages run
cd ../server && go mod download
To start the server run the following Go command
go run main.go serve
If you do changes to the database schema keep in mind to Export collections via the Pocketbase UI.
Paste the exported JSON into the pb_schema.json file and run the following npm script to update the frontend schema types.
cd ../webapp && pnpm typegen
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.
Please refer to our COMMIT_CONVENTION
- 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
- Go - The Backend Programming Language
- Pocketbase - The Backend Framework
- Simon Giesel - Project Lead & Initial work - Simon Giesel