RuneMarkers

https://runemarkers.net

Tiles

You can either contribute tiles directly by following the guide below, or create an issue with the Tiles Request template

Tiles Contribution

If you wish to contribute to tiles, follow the instructions below.

• Fork the repo
• Create a new branch with a name like so tiles/<tile name> e.g. tiles/vorkath-melee
• Add the tiles to the 'tiles' folder following the format used in other tiles (look at abyssal sire for an example)
• Commit the changes and push to the repo
• Open a pull request with a description of the changes
• Wait for the pull request to be accepted

Development

Using Docker (recommended)

To start the project locally using Docker, run:

docker-compose up
# or
docker compose up
# or if you want to run in the background
docker compose up -d

This will run a development server at http://localhost:3000 with hot reloading enabled.

Locally

To start the project locally, run:

pnpm dev

Open http://localhost:3000 with your browser to see the result.

Requirements

• Node.js >= 12.22.0
• PNPM = ^8.0.0

Scripts

• pnpm dev — Starts the application in development mode at http://localhost:3000.
• pnpm build — Creates an optimized production build of your application.
• pnpm start — Starts the application in production mode.
• pnpm type-check — Validate code using TypeScript compiler.
• pnpm lint — Runs ESLint for all files in the src directory.
• pnpm format — Runs Prettier for all files in the src directory.
• pnpm commit — Run commitizen. Alternative to git commit.

License

This project is licensed under the MIT License - see the LICENSE.md file for more information.

Contributors

Made with contrib.rocks.