Skip to content

Commit

Permalink
- update axios version on sendgrid dependency
Browse files Browse the repository at this point in the history
- update readme
- css only scrollbar
- fix TS errors
  • Loading branch information
MarioTiscareno committed Aug 14, 2024
1 parent 93959b3 commit 115171d
Show file tree
Hide file tree
Showing 5 changed files with 1,638 additions and 1,923 deletions.
72 changes: 45 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,10 @@
"type": "module",
"dependencies": {
"@sendgrid/mail": "^8.1.3"
},
"overrides": {
"@sendgrid/client": {
"axios": "^1.7.4"
}
}
}
Loading

0 comments on commit 115171d

Please sign in to comment.