diff --git a/README.md b/README.md index 187392f..7f75d3a 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,15 @@ This project is the open source version of the 'new' hypixel.maxkorlaar.com, which will be moved over to hypixel.paniek.de. The website is written in PHP using the Laravel framework. - ### Priorities + The signatures will be made based on a popularity vote. In [this Strawpoll](https://www.strawpoll.me/20018435), users can vote on the signatures they would most likely want to see and use. -## Using pnpm (Performant NPM) +## Getting started (for developers) -If you're using pnpm, execute `pnpm install --shamefully-hoist` instead of `pnpm install`. +See [Getting Started](docs/Getting%20started.md) for more information. ### Acknowledgements + * This projects makes heavy use of [hypixel-php](https://github.com/Plancke/hypixel-php) by Plancke. * For SkyBlock statistics, a lot of logic has been taken and inspired from the [skyblock-stats](https://github.com/LeaPhant/skyblock-stats) repository by Lea Seibert. I was kindly allowed to use her logic and variables in this project. diff --git a/docs/Getting started.md b/docs/Getting started.md new file mode 100644 index 0000000..05c07df --- /dev/null +++ b/docs/Getting started.md @@ -0,0 +1,46 @@ +# Getting started + +Welcome to the project! This guide will help you set up your development environment and get the project running. + +1. **Clone the repository** + + ```sh + git clone https://github.com/MaxKorlaar/hypixel-signatures.git + cd hypixel-signatures + ``` + +## Using dev containers + +1. **Open the project in a dev container** + + - [Instructions for PhpStorm](https://www.jetbrains.com/help/phpstorm/connect-to-devcontainer.html) + - Instructions for VS Code: open the project in VS Code Press `F1` and select `Dev Containers: Open Folder in Container` (Source: [Quick start: Open an existing folder in a container](https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-an-existing-folder-in-a-container)) + +## Locally + +`// TODO` + +## Running + +1. **Run a bunch of one-time commands** + + Note that if you're using pnpm, execute `pnpm install --shamefully-hoist` instead of `pnpm install`. + + ```sh + cp .env.example .env + pnpm install --shamefully-hoist + pnpm run development + php artisan key:generate + ``` + +2. **Start the development server** + + You can start the development server using the following command: + + ```sh + php artisan serve + ``` + +3. **Open the website** + + Open your browser and navigate to http://localhost:8000.