Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peterdee/exchange-web
WEB application for Exchange project
https://github.com/peterdee/exchange-web
common-styles socket-io typescript vercel vue
Last synced: about 3 hours ago
JSON representation
WEB application for Exchange project
- Host: GitHub
- URL: https://github.com/peterdee/exchange-web
- Owner: peterdee
- License: mit
- Created: 2023-07-26T12:09:24.000Z (over 1 year ago)
- Default Branch: release
- Last Pushed: 2023-11-07T08:30:53.000Z (about 1 year ago)
- Last Synced: 2023-11-07T09:33:05.547Z (about 1 year ago)
- Topics: common-styles, socket-io, typescript, vercel, vue
- Language: Vue
- Homepage: https://exchange.dyum.in
- Size: 186 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## exchange-web
[EXCHANGE](https://exchange.dyum.in) allows users to share files using browser on their devices
Shared files can be protected with a password
Stack: [Vue](https://vuejs.org), [Socket.IO](https://www.npmjs.com/package/socket.io-client), [Typescript](https://www.typescriptlang.org), [common-styles](https://github.com/julyskies/common-styles)
Demo: https://exchange.dyum.in
Backend project is available here: https://github.com/peterdee/exchange-backend
### Deploy
Clone repository
```shell script
git clone https://github.com/peterdee/exchange-web
cd ./exchange-web
nvm use 18
npm ci
```
Create a `certificates` directory in the project root
```shell script
mkdir certificates && cd certificates
```
Generate certificate files for HTTPS
```shell script
# Generate key file
openssl genrsa -out key.pem 2048
# Generate CSR
openssl req -new -sha256 -key key.pem -out csr.csr
# Generate certificate
openssl req -x509 -sha256 -days 365 -key key.pem -in csr.csr -out cert.pem
```
HTTPS is required for the [SubtleCrypto](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto) interface that works only in secure contexts
More details about certificate generating can be found [here](https://msol.io/blog/tech/create-a-self-signed-ssl-certificate-with-openssl)
### Environment variables
The `.env` file is required, see [.env.example](./.env.example) for details
### Launch
```shell script
npm run dev
```
Local WEB application will be available at https://localhost:3000
### Possible improvements
1. Improve data transfer security for password-proteced files: check grant for every requested file chunk
2. Allow sharing private files: make it possible to share files that are not publicly visible
### Vercel deployment
`release` branch is automatically deployed to [Vercel](https://vercel.com)
### License
[MIT](./LICENSE.md)