Skip to content

Commit cf30ae5

Browse files
Merge pull request #205 from SwiftFiddle/deploy-doc
Add deployment doc
2 parents f394212 + 32c7eea commit cf30ae5

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

DEPLOYMENT.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Deployment Instructions
2+
3+
## Prerequisites
4+
5+
Before deploying, make sure you have the following software installed on your machine:
6+
7+
- Node.js (v14 or newer)
8+
- Docker (v20.10 or newer)
9+
10+
The following environment variables are used for deployment:
11+
12+
- `FONTAWESOME_TOKEN`: This token is used for authentication with the FontAwesome service. You need to obtain a valid token from your FontAwesome account and use it here. Please make sure not to expose this token publicly.
13+
14+
## Local Deployment
15+
16+
### Steps:
17+
18+
1. Install the dependencies:
19+
20+
```bash
21+
npm install
22+
```
23+
24+
2. Run Webpack to build the project:
25+
26+
```bash
27+
npm run prod
28+
```
29+
30+
3. Run the application:
31+
32+
```bash
33+
swift run
34+
```
35+
36+
You should now be able to see the application running at `localhost:8080`.
37+
38+
## Production Deployment
39+
40+
For deploying to production, we recommend using [Render](https://render.com/). Render is a platform that allows you to deploy your application to the cloud with ease. It also provides a free tier that is sufficient for deploying this application.

0 commit comments

Comments
 (0)