https://github.com/michmich112/paraphrace

https://github.com/michmich112/paraphrace

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/michmich112/paraphrace
• Owner: michmich112
• Created: 2021-10-31T01:43:43.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-30T07:23:37.000Z (about 3 years ago)
• Last Synced: 2024-10-14T07:08:19.745Z (3 months ago)
• Language: Go
• Size: 528 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ParaphrAce

## Get started

First verify that you have Docker and Docker compose installed on your device.\

### With Storage

To use storage of the input and resulting sentences you will need to set up an AWS S3 bucket. The following steps are not necessary if you do not want or need storage.\

Create an S3 bucket in AWS, and an IAM user in the AWS console. The IAM user must be authenticated by Access key and Secret.\

Once the bucket created create a `.env` file at the root of the project with the following variables:

| Variable                | Description                                                  |

|-------------------------|--------------------------------------------------------------|

| `AWS_ACCESS_KEY_ID`     | AWS access key for s3                                        |

| `AWS_SECRET_ACCESS_KEY` | AWS secret for accessing s3                                  |

| `AWS_REGION`            | AWS region to use                                            |

| `S3_BUCKET_NAME`        | Name of the S3 Bucket to use                                 |

### Start the services

Run the following command: `docker compose build && docker compose up`

And the services will start up and you can access them here:

| service | port   | link                           |

|---------|--------|--------------------------------|

| Server  | `8080` | [api](http://localhost:8080)   |

| Model   | `8000` | [model](http://localhost:8000) |

| Client  | `5000` | [client](http://localhost:5000)|

You can connect to the Postgresql instace with the following credentials.

- host: `localhost`

- port: `5432`

- username: `paraphrace`

- password: `password`

- db name: `paraphrace`

- SSL: `disable`

> Note: You may need to restart the application after the initial boot. Just press `Ctrl+C` and then run `docker compose up once more`. The boot process can take up to a minute.

> Troubleshooting: if you are unable to start the application due to a docker error, try allowing more memory to the docker engine (through the docker dashboard). We've tested it with 4 CPUs & 8 GB of memory.

## Production Deployment

We've set up a Continuous deployment pipeline. To deploy, simply merge your commit into the `master` branch and the changes will be automatically deployed to the production instances.\

The client is hosted on Netlify while the Server and the Model are both hosted on Heroku.\

There are no configurations for you to add for this deployment to take effect properly.\

## Client

Front end client source code written in svelte and typescript

## Server

Back end server application written in GoLang

## Model

Machine learning model and interface