docs: add clearer install instructions, instructions for bun, fix link, lint

This commit is contained in:
Aidan 2025-03-27 15:11:28 -04:00
parent 8d72b0f1e7
commit 87c2e63248

View File

@ -1,27 +1,40 @@
# Giv's Website # Giv's Website
## Introduction ## Introduction
Hey, this is my website! You will be able to know what I'm good on and how to contact me through there. Hey, this is my website! You will be able to know what I'm good on and how to contact me through there.
## Used Technologies ## Technology Stack
- React - React
- TypeScript - TypeScript
- Vite - Vite
## How to access? ## How to access?
- Thanks to NineTailed, the deploy is available [here](https://givfnz.com) - Thanks to NineTailed, the deploy is available [here](https://givfnz.com)
- If you want to check the source code, visit the project repo on [Gitea](https://git.pontusmail.org/GivFNZ/my-website). - If you want to check the source code, visit the project repo on [Gitea](https://git.pontusmail.org/GivFNZ/my-website).
## Contributions ## Contributions
Any contribution is welcome. If you want to test the website in your own machine to help on this, make sure you have node.js installed, then clone the project repo and do the command:
`npm i` Any contribution is welcome. If you want to test the website in your own machine to help on this, make sure you have Node.js installed, then clone the project repo and run the following commands:
Then it will be available at localhost://5173. ### NPM
- `npm i` - Install dependencies
- `npm run dev` - Run dev server
### Bun
- `bun install` - Install dependencies
- `bun dev` - Run dev server
The development server will be available at http://localhost:5173.
## Special Thanks ## Special Thanks
- [Aidan](https://github.com/ihatenodejs) - [Aidan](https://github.com/ihatenodejs)
- [lucmsilva](https://github.com/lucmsilva651/) - [lucmsilva](https://github.com/lucmsilva651/)
- [NineTailedFox] - NineTailedFox
Enjoy! **Enjoy!**