https://github.com/thesoftwarehouse/rad-modules-serverless
https://github.com/thesoftwarehouse/rad-modules-serverless
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thesoftwarehouse/rad-modules-serverless
- Owner: TheSoftwareHouse
- Created: 2020-07-21T07:48:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-23T06:31:01.000Z (almost 5 years ago)
- Last Synced: 2025-01-11T13:27:50.088Z (5 months ago)
- Language: TypeScript
- Size: 171 KB
- Stars: 2
- Watchers: 14
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: security/initial-data/policy.json
Awesome Lists containing this project
README
# README
Welcome to RAD modules serveless
#### Development Local
- npm install
- rename .env.dist to .env
- fill all information
- docker-compose up
- npm run knex:migrate:latest
- npm run dev
#### Deploy
- npm install
- login using command `./node_modules/.bin/serverless config credentials --provider aws --key 1234 --secret 5678`
- deploy using command `./node_modules/.bin/serverless deploy -s dev/prod`;
#### Other good source of information
- https://serverless.com/framework/docs/providers/aws/guide/variables/
- https://serverless.com/framework/docs/providers/aws/cli-reference/config-credentials/
#### Lambdas
##### Files
POST /upload
Creates an entity and return its upload url
In order to upload a file use PUT request on a specific url.
**Mino**: Remember to set proper content-type for a file! For example an PNG image should be sent with headers: Content-Type: image/png.
**S3**: Remember to set content-type: octet-streams
Request
```
{
"fileName": "some-file.png",
"description": "some-descriptiuon",
"fileType": "image/png",
"permission": "public"
}
```
Response
```
{
"id": 1,
"fileName": "some-file.png",
"description": "some-descriptiuon",
"bucket": "test",
"status": 1,
"fileType": "image/png",
"permission": "public",
"key": "98964817-22bd-4537-99ed-99931828b063",
"createdAt": "2020-05-14T12:13:06.200Z",
"signedUrl": "http://127.0.0.1:9000/test/98964817-22bd-4537-99ed-99931828b063?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=s3accesskey%2F20200514%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20200514T121306Z&X-Amz-Expires=900&X-Amz-Signature=b313fcf1e641b8620e249bbc62f3e0088b54195e80a0dafd1d7f285a1afe5c52&X-Amz-SignedHeaders=host"
}
```
Example upload:
curl "http://127.0.0.1:9000/test/98964817-22bd-4537-99ed-99931828b063?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=s3accesskey%2F20200514%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20200514T121306Z&X-Amz-Expires=900&X-Amz-Signature=b313fcf1e641b8620e249bbc62f3e0088b54195e80a0dafd1d7f285a1afe5c52&X-Amz-SignedHeaders=host" --upload-file ./some-file.png -H "Content-Type:image/png"
GET /file?key=
Return information about single file and its private access signed url
Response
```
{
"id": 1,
"fileName": "some-file.png",
"description": "some-descriptiuon",
"bucket": "test",
"status": 1,
"fileType": "image/png",
"permission": "public",
"key": "98964817-22bd-4537-99ed-99931828b063",
"createdAt": "2020-05-14T12:13:06.200Z",
"signedUrl": "http://127.0.0.1:9000/test/98964817-22bd-4537-99ed-99931828b063?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=s3accesskey%2F20200514%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20200514T121421Z&X-Amz-Expires=900&X-Amz-Signature=5b7238b3b07cc8a134585dc9ba4070b2c01d371e54b590c8422fbba45c66ff98&X-Amz-SignedHeaders=host"
}
```
GET /files
Returns all files in database