diff --git a/README.md b/README.md index 5afe139..2baf54b 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,15 @@

Docker Minecraft Api

- 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.


+### Built With +[![Laravel][Laravel.com]][Laravel-url] +
@@ -41,33 +44,6 @@
-### Built With -[![Laravel][Laravel.com]][Laravel-url] - -
- - -## 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 @@ -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)_ -

(back to top)

+
- - - -## 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). - -

(back to top)

- - - - ## 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. -

(back to top)

+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 + +Marlon Maschkiwitz - marlon.maschkiwitz@4players.io
+Project Link - https://gitlab.4players.de/4np/apis/docker-minecraft-api ## License Distributed under the MIT License. See `LICENSE.txt` for more information. -

(back to top)

- - - - -## 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) - -

(back to top)

- - - - -## Acknowledgments - -* []() -* []() -* []() - -

(back to top)

- - - [contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge @@ -172,4 +114,4 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/ [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white [Bootstrap-url]: https://getbootstrap.com [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white -[JQuery-url]: https://jquery.com \ No newline at end of file +[JQuery-url]: https://jquery.com