website/README.md

71 lines
1.7 KiB
Markdown
Raw Normal View History

2023-12-13 14:08:40 +00:00
# Sangelo's Space
2023-11-05 22:58:33 +00:00
2023-12-13 14:08:40 +00:00
This is the source-code for my website, written in Svelte & SCSS.<br>
Feel free to explore!
2023-11-05 23:02:42 +00:00
2023-12-13 14:08:40 +00:00
## Contributing
2023-11-05 23:02:42 +00:00
2023-12-13 14:08:40 +00:00
You're welcome to contribute to this website if you have a Lunivity account (see homepage for details if registrations aren't open).<br>
Once you fork and clone the repository, follow the next steps.
2023-11-05 23:02:42 +00:00
2024-04-02 15:42:33 +00:00
If you have `just` installed, setting up is pretty easy:
```bash
# setup dependencies and run dev server
just
# you can also run `just dev`
just dev
# to build and preview a webpage, run `just preview`
just preview
```
View a list of all possible `just` recipes with `just -l`.
Otherwise, if you don't already have or don't want to install `just`, you can run the commands manually:
2023-11-05 23:02:42 +00:00
```bash
2023-12-13 14:08:40 +00:00
# install dependencies
yarn install
2023-11-05 23:02:42 +00:00
2023-12-13 14:08:40 +00:00
# run web dev server
yarn run dev
2023-11-05 23:02:42 +00:00
# or start the server and open the app in a new browser tab
2023-12-13 14:09:40 +00:00
yarn run dev --open
2023-11-05 23:02:42 +00:00
```
2023-12-13 14:08:40 +00:00
Once you've made your changes, you can create a Pull Request and I'll make sure to check it out!
2023-11-05 23:02:42 +00:00
## Building
2024-04-02 15:42:33 +00:00
To create a production version of this website without docker:
2023-11-05 23:02:42 +00:00
```bash
2023-12-13 14:08:40 +00:00
yarn run build
2023-11-05 23:02:42 +00:00
```
2024-04-02 15:42:33 +00:00
To build a docker container image with `just`:
```bash
# build and run container image with docker
just build
# build with podman
just build podman
# clean, build, and run container image with docker or podman
just all
just all podman
```
2023-12-13 14:08:40 +00:00
You can preview the production build with `yarn run preview`.
## License
2023-11-05 23:02:42 +00:00
2024-03-22 12:03:42 +00:00
You can view this project's source code license [here](./LICENSE).
2024-04-02 15:42:33 +00:00
All assets (images, logos, etc.) created by me (Sangelo) are Copyright (c) 2019-2024 Sangelo unless otherwise stated.<br>
Brand logos and icons (such as Discord, Github, YouTube, etc.) are trademarked by and copyright of their respective owners.