website/README.md

37 lines
813 B
Markdown
Raw Permalink 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
```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
2023-12-13 14:08:40 +00:00
To create a production version of this website:
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
```
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
2023-12-13 14:08:40 +00:00
You can view this project's license [here](./LICENSE).