diff --git a/README.md b/README.md index 701af63..5afe139 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,14 @@ - - - - - - - - -[![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] - - -
- - Logo - + Logo -

project_title

+

Docker Minecraft Api

- project_description -
- Explore the docs » -
-
- View Demo - · - Report Bug - · - Request Feature + This api contains information about minecraft docker mods and their available versions, as well as the executable version to run them.

+
@@ -78,65 +39,32 @@ - - - -## 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` - -

(back to top)

- - +
### 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] - -

(back to top)

- - +
## 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` -

(back to top)