2024-04-08 15:18:20 +00:00
|
|
|
<div align="center"> <img src="https://gitpot.org/sangelo/website/raw/branch/main/static/assets/img/sangelos-space-readme.png"/ width=11%> </div>
|
2024-04-08 15:15:39 +00:00
|
|
|
|
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
|
|
|
|
2024-04-03 13:19:01 +00:00
|
|
|
You're welcome to contribute to this website if you have a Lunivity account (see Gitpot's homepage for details if registrations aren't open).<br>
|
2023-12-13 14:08:40 +00:00
|
|
|
Once you fork and clone the repository, follow the next steps.
|
2023-11-05 23:02:42 +00:00
|
|
|
|
2024-04-03 13:07:18 +00:00
|
|
|
If you have [`just`](https://github.com/casey/just/) installed, setting up is pretty easy:
|
2024-04-02 15:42:33 +00:00
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# setup dependencies and run dev server
|
|
|
|
|
just
|
|
|
|
|
|
|
|
|
|
# you can also run `just dev`
|
|
|
|
|
just dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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-03 11:08:42 +00:00
|
|
|
### Build locally
|
|
|
|
|
|
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
|
2024-04-03 11:08:42 +00:00
|
|
|
# automatically build & preview
|
|
|
|
|
just preview
|
|
|
|
|
|
|
|
|
|
# or, manually build
|
2023-12-13 14:08:40 +00:00
|
|
|
yarn run build
|
2023-11-05 23:02:42 +00:00
|
|
|
```
|
|
|
|
|
|
2024-04-03 11:08:42 +00:00
|
|
|
You can then preview the production build locally with `yarn run preview --open`.
|
|
|
|
|
|
|
|
|
|
The files will be available in the repo, in the `build/` directory.
|
|
|
|
|
|
|
|
|
|
### Build with Docker
|
|
|
|
|
|
2024-04-02 15:42:33 +00:00
|
|
|
To build a docker container image with `just`:
|
|
|
|
|
|
|
|
|
|
```bash
|
2024-04-03 11:08:42 +00:00
|
|
|
# build and run container image with docker, tag: latest
|
2024-04-02 15:42:33 +00:00
|
|
|
just build
|
|
|
|
|
|
|
|
|
|
# build with podman
|
2024-04-03 11:08:42 +00:00
|
|
|
just build <tag> podman
|
2024-04-02 15:42:33 +00:00
|
|
|
|
2024-04-03 11:08:42 +00:00
|
|
|
# clean, build, and run container image with docker, tag: latest
|
2024-04-02 15:42:33 +00:00
|
|
|
just all
|
2024-04-03 11:08:42 +00:00
|
|
|
# clean, build, and run container image with podman, tag: dev
|
|
|
|
|
just all dev podman
|
2024-04-02 15:42:33 +00:00
|
|
|
```
|
|
|
|
|
|
2024-04-03 11:08:42 +00:00
|
|
|
You can preview the produced docker build with `just run [tag] [runner]`.
|
2023-12-13 14:08:40 +00:00
|
|
|
|
|
|
|
|
## 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.
|
