-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- update axios version on sendgrid dependency
- update readme - css only scrollbar - fix TS errors
- Loading branch information
1 parent
93959b3
commit 115171d
Showing
5 changed files
with
1,638 additions
and
1,923 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,45 +25,63 @@ Everything is on one page, which works for what I need right now. | |
|
||
## Install and Run ▶️ | ||
|
||
``` | ||
# Clone this repository | ||
$ git clone https://github.com/MarioTiscareno/sveltekit-personal-website | ||
``` | ||
1. Clone this repository | ||
|
||
``` | ||
# Go into the repository | ||
$ cd sveltekit-personal-website | ||
``` | ||
``` | ||
git clone https://github.com/MarioTiscareno/sveltekit-personal-website | ||
``` | ||
|
||
``` | ||
# Rename the file .env.example to .env.local | ||
2. Go into the repository | ||
|
||
# Linux Bash | ||
$ mv .env.example .env.local | ||
``` | ||
cd sveltekit-personal-website | ||
``` | ||
|
||
# Windows CMD | ||
$ ren .env.example .env.local | ||
``` | ||
3. Rename the file .env.example to .env.local | ||
|
||
``` | ||
# Install dependencies | ||
$ npm install | ||
``` | ||
3.1 Linux | ||
|
||
``` | ||
# Start the project in development | ||
$ npm run dev | ||
``` | ||
``` | ||
mv .env.example .env.local | ||
``` | ||
|
||
3.2 Windows | ||
|
||
``` | ||
ren .env.example .env.local | ||
``` | ||
|
||
4. Install dependencies | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
5. Start the project in development | ||
|
||
``` | ||
npm run dev | ||
``` | ||
|
||
Open your browser and go to `http://localhost:5173`. | ||
|
||
## SendGrid and Mailgun contact form integration 📬 | ||
|
||
You can configure SendGrid or Mailgun to receive contact form submissions in your mailbox. This can be handy if you don't want to expose your personal email. | ||
|
||
To configure just set the appropriate values in .env.local. MAIL_PROVIDER should be set to 'sendgrid' or 'mailgun', using any other value will not do anything, but you will still get a 200 back from the endpoint. | ||
DON'T remove any variables from the .env file, as this will break the build, instead you can leave empty what you don't need. | ||
To configure just set the appropriate values in .env.local. | ||
|
||
```bash | ||
SENDGRID_API_KEY='YOUR_API_KEY' | ||
SENDGRID_SENDER='[email protected]' | ||
|
||
MAILGUN_DOMAIN='your.domain.com' | ||
MAILGUN_API_KEY='YOUR_API_KEY' | ||
MAILGUN_SENDER='[email protected]' | ||
|
||
## Acknowledgements 🙏 | ||
EMAIL_TO='[email protected]' | ||
|
||
MAIL_PROVIDER='mailgun' # mailgun | sendgrid | none | ||
``` | ||
|
||
- [I am using daylilyfield's very cool svrollbar component](https://github.com/daylilyfield/svrollbar) | ||
DON'T remove any variables from the .env file, as this will break the build, instead you can set to empty strings what you don't need. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.