website/README.md

64 lines
1.6 KiB
Markdown
Raw Normal View History

2023-06-09 17:25:14 +00:00
# ExploreCraft: Website
2024-06-12 09:03:14 +00:00
This is the ExploreCraft Website. Created with Svelte, PicoCSS, and dedication by [Sangelo](https://gitpot.org/sangelo/) & [LogolicusZ](https://gitpot.org/LogolicusZ/).
2023-06-04 22:25:15 +00:00
2023-06-09 17:25:14 +00:00
<a href="https://explorecraft.net">
<picture>
2024-06-12 09:03:14 +00:00
<source srcset="docs/assets/screenshot-dark.png" media="(prefers-color-scheme: dark)" alt="ExploreCraft Website Screenshot">
<img src="docs/assets/screenshot-light.png" alt="ExploreCraft Website Screenshot">
2023-06-09 17:25:14 +00:00
</picture>
</a>
2023-06-04 22:25:15 +00:00
2023-06-09 17:25:14 +00:00
## License
2024-06-12 09:03:14 +00:00
2023-06-16 13:57:23 +00:00
This project is licensed under the MPL v2.0. More info [here](./LICENSE).
2023-06-04 22:25:15 +00:00
2023-06-09 17:25:14 +00:00
## Developing
2024-06-12 09:03:14 +00:00
2023-06-09 17:25:14 +00:00
To start developing, clone the repository.
2024-06-12 09:03:14 +00:00
2023-06-04 22:25:15 +00:00
```bash
2023-06-09 17:25:14 +00:00
# clone the website
git clone https://gitpot.org/ExploreCraft/website.git
2023-06-04 22:25:15 +00:00
```
2023-06-09 17:25:14 +00:00
Once you've cloned the repository you'll need to install the required dependencies, and then, start a development server:
2023-06-04 22:25:15 +00:00
```bash
2024-06-12 08:59:40 +00:00
# install dependencies (you can also use pyarn install or yarn)
yarn install
2023-06-09 17:25:14 +00:00
# start vite development server
2024-06-12 08:59:40 +00:00
yarn run dev
2023-06-04 22:25:15 +00:00
2023-06-09 17:25:14 +00:00
# or start the server and also open the website in a new browser tab
2024-06-12 08:59:40 +00:00
yarn run dev -- --open
2023-06-09 17:25:14 +00:00
VITE v4.3.9 ready in 358 ms
➜ Local: http://127.0.0.1:5173/
➜ Network: use --host to expose
➜ press h to show help
2023-06-04 22:25:15 +00:00
```
2024-06-12 09:03:14 +00:00
2023-06-09 17:25:14 +00:00
This server will automatically apply changes you do to the code, so just start working and Vite will do the rest. No need to refresh!
2023-06-04 22:25:15 +00:00
## Building
2023-06-09 17:25:14 +00:00
To build a production-ready version of this website:
2023-06-04 22:25:15 +00:00
```bash
2023-06-09 17:25:14 +00:00
# run build action
2024-06-12 08:59:40 +00:00
yarn run build
2023-06-04 22:25:15 +00:00
```
2024-06-12 09:03:14 +00:00
2023-06-09 17:25:14 +00:00
You can also preview the production build (You'll need to build the website first if you haven't done so already):
2023-06-04 22:25:15 +00:00
2023-06-09 17:25:14 +00:00
```bash
# build the website
2024-06-12 08:59:40 +00:00
yarn run build
2023-06-04 22:25:15 +00:00
2023-06-09 17:25:14 +00:00
# start a preview server
2024-06-12 08:59:40 +00:00
yarn run preview
```