docs

README.md

-# App name
+# jsdelivr-uploader
 
-App description.
+An assets uploader using jsdelivr as CDN.
 
 ## Environment
 
-* `DB_HOST` `DB_PORT` `DB_USER` `DB_PASS` `DB_NAME` Database configs.
+* `DB_HOST` `DB_PORT` `DB_USER` `DB_PASS` `DB_NAME` PostgreSQL database configs.
+
+* `GITHUB_REPO` `GITHUB_USER` GitHub repo. The repo should be available at `https://github.com/<user>/<repo>`. An empty repo would be OK.
+
+* `GITHUB_TOKEN` GitHub token, for authorization of pushing commits. Either `username:password` or token from GitHub settins would be allowed.
+
+* `REPO_PATH` Path of the local repo. Default: `/tmp/repo`.
+
+## API
+
+Refer to Swagger API docs at `/docs`.
 
 ## Installation
 

src/app.controller.ts

@@ -20,7 +20,7 @@ export class AppController {
   @Post('upload')
   @ApiConsumes('multipart/form-data')
   @ApiBody({
-    description: '上传的文件',
+    description: 'Assets to upload',
     type: FileUploadDto,
   })
   @UseInterceptors(

src/dto/ReturnMessage.dto.ts

@@ -3,11 +3,11 @@ import { HttpException } from '@nestjs/common';
 import { File } from '../entities/File.entity';
 
 export class BlankReturnMessageDto {
-  @ApiProperty({ description: '返回状态' })
+  @ApiProperty({ description: 'Return status code' })
   statusCode: number;
-  @ApiProperty({ description: '返回信息' })
+  @ApiProperty({ description: 'Return message' })
   message: string;
-  @ApiProperty({ description: '是否成功' })
+  @ApiProperty({ description: 'Whether it succeeded or not' })
   success: boolean;
   constructor(statusCode: number, message?: string) {
     this.statusCode = statusCode;
@@ -21,7 +21,7 @@ export class BlankReturnMessageDto {
 }
 
 export class ReturnMessageDto<T> extends BlankReturnMessageDto {
-  @ApiProperty({ description: '返回内容' })
+  @ApiProperty({ description: 'Returning data.' })
   data?: T;
   constructor(statusCode: number, message?: string, data?: T) {
     super(statusCode, message);
@@ -30,5 +30,6 @@ export class ReturnMessageDto<T> extends BlankReturnMessageDto {
 }
 
 export class StringReturnMessageDto extends BlankReturnMessageDto {
+  @ApiProperty({ description: 'The URL should be here.' })
   data: string;
 }

src/main.ts

@@ -9,8 +9,8 @@ async function bootstrap() {
   app.set('trust proxy', ['172.16.0.0/12', 'loopback']);
 
   const documentConfig = new DocumentBuilder()
-    .setTitle('app')
-    .setDescription('The app')
+    .setTitle('jsdelivr-uploader')
+    .setDescription('An assets uploader using jsdelivr as CDN.')
     .setVersion('1.0')
     .build();