Skip to content

Add deployment doc #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions DEPLOYMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Deployment Instructions

## Prerequisites

Before deploying, make sure you have the following software installed on your machine:

- Node.js (v14 or newer)
- Docker (v20.10 or newer)

The following environment variables are used for deployment:

- `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.

## Local Deployment

### Steps:

1. Install the dependencies:

```bash
npm install
```

2. Run Webpack to build the project:

```bash
npm run prod
```

3. Run the application:

```bash
swift run
```

You should now be able to see the application running at `localhost:8080`.

## Production Deployment

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.