zino/seatmapv2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
zino
2023-01-30 11:52:31 +01:00
parent 1bc4d20619
commit de478d0aa7
1 changed files with 24 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
README.md
View File

@@ -6,12 +6,15 @@
<h3 align="center">Docker Minecraft Api</h3>
<p align="center">
This api contains information about minecraft docker mods and their available versions, as well as the executable version to run them.
Serve information about minecraft docker mods, their available versions and needed executables.
</p>
<br/>
</div>
### Built With
[![Laravel][Laravel.com]][Laravel-url]
<br/>
<!-- TABLE OF CONTENTS -->
<details>
@@ -41,33 +44,6 @@
<br/>
### Built With
[![Laravel][Laravel.com]][Laravel-url]
<br/>
<!-- GETTING STARTED -->
## Getting Started
To get a local copy up and running follow these simple example steps. Before cloning this project, you should ensure that your local machine has PHP and Composer installed.
### Installation
1. Clone the repo: `git clone https://gitlab.4players.de/4np/apis/docker-minecraft-api.git`
2. Install composer packages: `composer install`
3. After composer installation create .env file in your project root folder & copy everything from .env.example file into .env file. Then run `php artisan key:generate`, which will generate an APP_KEY in .env file for you.
4. Setup your DB_DATABASE, DB_USERNAME & DB_PASSWORD in .env file.
5. Run migrations: `php artisan migrate`
6. Import json to database: `php artisan json:import`
<!-- USAGE EXAMPLES -->
## Usage
@@ -75,73 +51,39 @@ Use this space to show useful examples of how a project can be used. Additional
_For more examples, please refer to the [Documentation](https://example.com)_
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<br/>
<!-- ROADMAP -->
## Roadmap
- [ ] Feature 1
- [ ] Feature 2
- [ ] Feature 3
- [ ] Nested Feature
See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. Before cloning this project, you should ensure that your local machine has PHP and Composer installed. To get a local copy up and running follow these steps.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Clone the repo and install composer packages:
```
git clone https://gitlab.4players.de/4np/apis/docker-minecraft-api.git
composer install
```
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
2. After composer installation create .env file in your project root folder & copy everything from .env.example file into .env file. Then run `php artisan key:generate`, which will generate an APP_KEY in .env file for you. After, setup your DB_DATABASE, DB_USERNAME & DB_PASSWORD in .env file.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
3. Run migrations and import json to database:
```
php artisan migrate
php artisan json:import
```
4. Serve the project via `php artisan serve` or [Laravel Homestead](https://fourplayers.atlassian.net/wiki/spaces/4NET/pages/1035206657/Homestead+Installation).
<!-- CONTACT -->
## Contact
Marlon Maschkiwitz - marlon.maschkiwitz@4players.io <br/>
Project Link - https://gitlab.4players.de/4np/apis/docker-minecraft-api
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
* []()
* []()
* []()
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge