logolicusz/Explorecraft_Logolcicusz_Knockoff
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Updated readme

Browse source
This commit is contained in:
LogolicusZ 2024-04-19 11:09:30 +02:00
parent fe752192ff
commit b6cdfeac4d
1 changed files with 3 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -1,57 +1,4 @@
# ExploreCraft: Website
This is the ExploreCraft Website. Created with Svelte, PicoCSS, and dedication by [Sangelo](https://gitpot.dev/sangelo/) & [LogolicusZ](https://gitpot.dev/LogolicusZ/).
# LogolicusZ Basic Website
<a href="https://explorecraft.net">
<picture>
<source srcset="docs/assets/screenshot-dark.png" media="(prefers-color-scheme: dark)">
<img src="docs/assets/screenshot-light.png">
</picture>
</a>
## License
This project is licensed under the MPL v2.0. More info [here](./LICENSE).
## Developing
To start developing, clone the repository.
```bash
# clone the website
git clone https://gitpot.dev/ExploreCraft/website.git
```
Once you've cloned the repository you'll need to install the required dependencies, and then, start a development server:
```bash
# install dependencies (you can also use pnpm install or yarn)
npm install
# start vite development server
npm run dev
# or start the server and also open the website in a new browser tab
npm run dev -- --open
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
```
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!
## Building
To build a production-ready version of this website:
```bash
# run build action
npm run build
```
You can also preview the production build (You'll need to build the website first if you haven't done so already):
```bash
# build the website
npm run build
# start a preview server
npm run preview
```
## Doku
https://pad.lunivity.com/s/O9FeANXrU