mirror of
https://github.com/xHyroM/website.git
synced 2024-11-10 01:38:05 +01:00
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
<img src="https://github.com/xHyroM/website/blob/main/src/assets/logo.png?raw=true" alt="Hyro" width="256">
|
|
<br>
|
|
</h1>
|
|
|
|
<h4 align="center">Source code for hyro's website, simple and modern page.</h4>
|
|
|
|
<p align="center">
|
|
<a href="https://s.xhyrom.dev/discord" alt="Discord">
|
|
<img src="https://img.shields.io/discord/1046534628577640528?label=discord&style=for-the-badge&color=2fbfc4"/>
|
|
</a>
|
|
</p>
|
|
|
|
## Setup
|
|
|
|
1. Clone this repository: `git clone https://github.com/xHyroM/website.git`
|
|
2. Navigate to the project directory: `cd website`
|
|
3. Install the dependencies: `bun install`
|
|
|
|
## Usage
|
|
|
|
- To run the development server: `bun run dev`
|
|
- To build the project for production: `bun run build`
|
|
- To preview the production build: `bun run preview`
|
|
|
|
## Contributing
|
|
|
|
To contribute to this project, please follow the [standard Git workflow](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository#The-Standard-Git-Workflow) and [CONTRIBUTING](./CONTRIBUTING.md).
|
|
|
|
1. Fork this repository
|
|
2. Create a new branch for your changes: `git checkout -b my-feature`
|
|
3. Commit your changes: `git commit -am "Add my feature"`
|
|
4. Push the branch: `git push origin my-feature`
|
|
5. Open a pull request
|
|
|
|
## License
|
|
|
|
This project is licensed under the [Apache-2.0 License](LICENSE).
|