Updated README.md content

This commit is contained in:
2025-01-28 16:02:35 +01:00
parent 8994ec306a
commit 69e605fc93

View File

@@ -1,5 +1,26 @@
# Vue 3 + TypeScript + Vite
<img align="right" src="https://github.com/discord-jda/JDA/blob/assets/assets/readme/logo.png?raw=true" height="150" width="150">
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
# CoasterDB
Roller coaster and amusement park database with web view as a project for the seminar subject s_Tec (Q1.2)
Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
## Summary
1. [Installation](#installation)
2. [Getting started](#getting-started)
3. [Contributing](#contributing-to-the-project)
## Installation
Just clone the project and install all dependencies via:
```sh
$ npm install
```
## Getting started
If you configured everything adjusted to your needs, you can start the development server via:
```sh
$ npm run dev
```
## Contributing to the project
Use the development branch for further updates.<br>
The development branch will only be merged with the master if the new version is completely finished for being live.<br>
Follow the [Contributing Guidelines](https://github.com/MiauRizius/CoasterDB/blob/master/.github/CONTRIBUTING.md).