26 lines
948 B
Markdown
26 lines
948 B
Markdown
<!-- <img align="right" src="https://github.com/discord-jda/JDA/blob/assets/assets/readme/logo.png?raw=true" height="150" width="150"> -->
|
|
|
|
# CoasterDB
|
|
Roller coaster and amusement park database with web view as a project for the seminar subject s_Tec (Q1.2)
|
|
|
|
## 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). |