seatmapv2/README.md

Docker Minecraft Api

This api contains information about minecraft docker mods and their available versions, as well as the executable version to run them.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Built With

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

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open 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. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/github_username/repo_name

(back to top)

Acknowledgments

(back to top)