Update 'README.md'
This commit is contained in:
110
README.md
110
README.md
@@ -1,53 +1,14 @@
|
||||
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
|
||||
<a name="readme-top"></a>
|
||||
<!--
|
||||
*** Thanks for checking out the Best-README-Template. If you have a suggestion
|
||||
*** that would make this better, please fork the repo and create a pull request
|
||||
*** or simply open an issue with the tag "enhancement".
|
||||
*** Don't forget to give the project a star!
|
||||
*** Thanks again! Now go create something AMAZING! :D
|
||||
-->
|
||||
|
||||
|
||||
|
||||
<!-- PROJECT SHIELDS -->
|
||||
<!--
|
||||
*** I'm using markdown "reference style" links for readability.
|
||||
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
||||
*** See the bottom of this document for the declaration of the reference variables
|
||||
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
||||
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
||||
-->
|
||||
[![Contributors][contributors-shield]][contributors-url]
|
||||
[![Forks][forks-shield]][forks-url]
|
||||
[![Stargazers][stars-shield]][stars-url]
|
||||
[![Issues][issues-shield]][issues-url]
|
||||
[![MIT License][license-shield]][license-url]
|
||||
[![LinkedIn][linkedin-shield]][linkedin-url]
|
||||
|
||||
|
||||
|
||||
<!-- PROJECT LOGO -->
|
||||
<br />
|
||||
<div align="center">
|
||||
<a href="https://github.com/github_username/repo_name">
|
||||
<img src="images/logo.png" alt="Logo" width="80" height="80">
|
||||
</a>
|
||||
<img src="https://dl.zinomedia.de/4netplayers.png" alt="Logo">
|
||||
|
||||
<h3 align="center">project_title</h3>
|
||||
<h3 align="center">Docker Minecraft Api</h3>
|
||||
|
||||
<p align="center">
|
||||
project_description
|
||||
<br />
|
||||
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
|
||||
<br />
|
||||
<br />
|
||||
<a href="https://github.com/github_username/repo_name">View Demo</a>
|
||||
·
|
||||
<a href="https://github.com/github_username/repo_name/issues">Report Bug</a>
|
||||
·
|
||||
<a href="https://github.com/github_username/repo_name/issues">Request Feature</a>
|
||||
This api contains information about minecraft docker mods and their available versions, as well as the executable version to run them.
|
||||
</p>
|
||||
<br/>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -78,65 +39,32 @@
|
||||
</ol>
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
<!-- ABOUT THE PROJECT -->
|
||||
## About The Project
|
||||
|
||||
[![Product Name Screen Shot][product-screenshot]](https://example.com)
|
||||
|
||||
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
### Built With
|
||||
[![Laravel][Laravel.com]][Laravel-url]
|
||||
|
||||
* [![Next][Next.js]][Next-url]
|
||||
* [![React][React.js]][React-url]
|
||||
* [![Vue][Vue.js]][Vue-url]
|
||||
* [![Angular][Angular.io]][Angular-url]
|
||||
* [![Svelte][Svelte.dev]][Svelte-url]
|
||||
* [![Laravel][Laravel.com]][Laravel-url]
|
||||
* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
|
||||
* [![JQuery][JQuery.com]][JQuery-url]
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
<!-- GETTING STARTED -->
|
||||
## Getting Started
|
||||
|
||||
This is an example of how you may give instructions on setting up your project locally.
|
||||
To get a local copy up and running follow these simple example steps.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
This is an example of how to list things you need to use the software and how to install them.
|
||||
* npm
|
||||
```sh
|
||||
npm install npm@latest -g
|
||||
```
|
||||
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. Get a free API Key at [https://example.com](https://example.com)
|
||||
2. Clone the repo
|
||||
```sh
|
||||
git clone https://github.com/github_username/repo_name.git
|
||||
```
|
||||
3. Install NPM packages
|
||||
```sh
|
||||
npm install
|
||||
```
|
||||
4. Enter your API in `config.js`
|
||||
```js
|
||||
const API_KEY = 'ENTER YOUR API';
|
||||
```
|
||||
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`
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user