Aktualizuj README.md
Some checks are pending
Release / release (push) Waiting to run
Test / Run tests (push) Waiting to run

This commit is contained in:
SloudPL 2025-03-19 18:36:46 +01:00
parent df7dddae70
commit 90ef3ade28

152
README.md
View file

@ -1,76 +1,76 @@
# SloudPLPage # SloudPLPage
Welcome to the **SloudPLPage** project! This site is made for [SloudPL](https://sloud.pl/). It offers game server hosting and other services. Welcome to the **SloudPLPage** project! This site is made for [SloudPL](https://sloudhost.ovh/).
## Table of Contents ## Table of Contents
- [Demo](#demo) - [Demo](#demo)
- [Installation](#installation) - [Installation](#installation)
- [Technologies](#technologies) - [Technologies](#technologies)
- [Contributing](#contributing) - [Contributing](#contributing)
- [Authors](#authors) - [Authors](#authors)
- [License](#license) - [License](#license)
## Demo ## Demo
Check out the live demo [here](https://sloud.pl/). Check out the live demo [here](https://sloudhost.ovh/).
## Installation ## Installation
To get a local copy up and running, follow these simple steps: To get a local copy up and running, follow these simple steps:
### Prerequisites ### Prerequisites
- **Node.js**: Ensure you have Node.js installed. You can download it from [nodejs.org](https://nodejs.org/). - **Node.js**: Ensure you have Node.js installed. You can download it from [nodejs.org](https://nodejs.org/).
### Clone the repository ### Clone the repository
```sh ```sh
git clone https://github.com/LakioLive/SloudPLPage git clone https://github.com/LakioLive/SloudPLPage
cd SloudPLPage cd SloudPLPage
``` ```
### Install dependencies ### Install dependencies
```sh ```sh
npm install npm install
``` ```
### Start the development server ### Start the development server
```sh ```sh
npm run dev npm run dev
``` ```
Open [http://localhost:5173](http://localhost:5173) to view it in the browser. Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
## Technologies ## Technologies
- **TypeScript**: Typed superset of JavaScript that compiles to plain JavaScript. - **TypeScript**: Typed superset of JavaScript that compiles to plain JavaScript.
- **React**: JavaScript library for building user interfaces. - **React**: JavaScript library for building user interfaces.
- **Vite**: Next-generation frontend tooling for fast and optimized builds. - **Vite**: Next-generation frontend tooling for fast and optimized builds.
- **TailwindCSS**: Utility-first CSS framework for rapid UI development. - **TailwindCSS**: Utility-first CSS framework for rapid UI development.
- **Sass**: CSS preprocessor that adds power and elegance to the basic language. - **Sass**: CSS preprocessor that adds power and elegance to the basic language.
- **i18next**: Internationalization framework for translating your React applications. - **i18next**: Internationalization framework for translating your React applications.
- **React Icons**: Include popular icons in your React projects easily. - **React Icons**: Include popular icons in your React projects easily.
## Contributing ## 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**. Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
### Steps to Contribute ### Steps to Contribute
1. Fork the Project 1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/YourFeature`) 2. Create your Feature Branch (`git checkout -b feature/YourFeature`)
3. Commit your Changes (`git commit -m 'Add some YourFeature'`) 3. Commit your Changes (`git commit -m 'Add some YourFeature'`)
4. Push to the Branch (`git push origin feature/YourFeature`) 4. Push to the Branch (`git push origin feature/YourFeature`)
5. Open a Pull Request 5. Open a Pull Request
## Authors ## Authors
LakioLive [LakioLive](https://github.com/LakioLive)
SloudPL SloudPL
## License ## License
Distributed under the **MIT License**. See `LICENSE` for more information. Distributed under the **MIT License**. See `LICENSE` for more information.