Merge pull request 'Readme without License initial commit' (#3) from readme-update into main

Reviewed-on: https://gitpot.dev/sangelo/explorecraft-testing/pulls/3
This commit is contained in:
Sangelo 2023-06-09 19:25:52 +02:00
commit 2ad5777616
4 changed files with 38 additions and 49 deletions

1
LICENSE Normal file
View file

@ -0,0 +1 @@
[CHOOSE A LICENSE]

View file

@ -1,69 +1,57 @@
# create-svelte
# ExploreCraft: Website
This is the ExploreCraft Website. Created with Svelte, PicoCSS, and dedication by [Sangelo](https://gitpot.dev/sangelo/) & [LogolicusZ](https://gitpot.dev/LogolicusZ/).
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
<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>
## Creating a project
If you're seeing this, you've probably already done this step. Congrats!
```bash
# create a new project in the current directory
npm create @svelte-add/kit@latest
Svelte Add's SvelteKit app initializer (Version 2023.06.30.00)
✔ What directory should your app be created in? … explorecraft-testing
✔ What scripting language will you write your app in? JavaScript
✔ What language will you write your app styles in? SCSS (used by Bootstrap and Bulma and PicoCSS)
✔ What framework will you use for your app's styles? PicoCSS
✔ What other features do you want for your app?
✔ What code quality tools do you want to help maintain your app?
✔ Where will you deploy your app? Nowhere (set up a deployment target later)
✔ Do you want example code added to your app to demonstrate how to use the tools you've selected? Yes
✔ Should your app's dependencies be installed with npm right now? Yes
=============
WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.
You may find that it works just fine, or you may not.
SUPPORTED TYPESCRIPT VERSIONS: >=3.3.1 <5.1.0
YOUR TYPESCRIPT VERSION: 5.1.3
Please only submit bug reports when using the officially supported version.
=============
🪄 Your JavaScript + SCSS + PicoCSS SvelteKit app is ready!
1. cd explorecraft-testing-sveltekit
2. npm run dev -- --open # start developing with a browser open
cd explorecraft-testing
```
## License
This project is licensed under the [choose license]. 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 created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
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 open the app in a new browser tab
# 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 create a production version of your app:
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):
You can preview the production build with `npm run preview`.
```bash
# build the website
npm run build
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
-----
- `git clone https://gitpot.dev/sangelo/explorecraft-testing.git && cd explorecraft-testing`
- `npm install`
- `npm run dev`
# start a preview server
npm run preview
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 856 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 871 KiB