Skip to content

Commit 53899a1

Browse files
shinshinwuyyx990803
authored andcommitted
update docs on how to deploy project to surge.sh (#1864)
pretty straightforward!
1 parent cc9a6c2 commit 53899a1

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/guide/deployment.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -167,4 +167,24 @@ Please refer on the [Firebase Documentation](https://firebase.google.com/docs/ho
167167
168168
### Surge
169169

170-
> TODO | Open to contribution.
170+
To deploy with [Surge](http://surge.sh/) the steps are very straightforward.
171+
172+
First you would need to build your project by running `npm run build`. And if you haven't installed Surge's command line tool, you can simply do so by running the command:
173+
174+
```
175+
npm install --global surge
176+
```
177+
178+
Then cd into the `dist/` folder of your project and then run `surge` and follow the screen prompt. It will ask you to set up email and password if it is the first time you are using Surge. Confirm the project folder and type in your preferred domain and watch your project being deployed such as below.
179+
180+
```
181+
project: /Users/user/Documents/myawesomeproject/dist/
182+
domain: myawesomeproject.surge.sh
183+
upload: [====================] 100% eta: 0.0s (31 files, 494256 bytes)
184+
CDN: [====================] 100%
185+
IP: **.**.***.***
186+
187+
Success! - Published to myawesomeproject.surge.sh
188+
```
189+
190+
Verify your project is successfully published by Surge by visiting `myawesomeproject.surge.sh`, vola! For more setup details such as custom domains, you can visit [Surge's help page](https://surge.sh/help/).

0 commit comments

Comments
 (0)