netless-io / netless-io/flat-server

Readme.md

Open
#461 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
684
Forks
277
PR merge metrics
No merged PRs in 30d

Description

Hello,

It seems to me that there are some bugs on the Readme.md :

  1. For the order :
    docker run -dit -p 3306:3306 --name mysql --restart always -v pwd/data:/var/lib/mysql -v pwd/conf.d:/etc/mysql/conf.d -e MYSQL_ROOT_PASSWORD=(value of MYSQL_PASSWORD) mysql

Error :
docker: Error response from daemon: create pwd/data: "pwd/data" includes invalid characters for a local volume name, only "[a-zA-Z0-9][a-zA-Z0-9_.-]" are allowed. If you intended to pass a host directory, use absolute path.

2. Folder thirdPartyService doesn't exist in src/v1/

3. Folder "dist" is created after the run and there is an Error :

C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\node_modules\ali-oss\lib\common\client\initOptions.js:24
throw new Error('require accessKeyId, accessKeySecret');
^
Error: require accessKeyId, accessKeySecret
at module.exports (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\node_modules\ali-oss\lib\common\client\initOptions.js:24:11)
at Function.initOptions (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\node_modules\ali-oss\lib\client.js:54:10)
at new Client (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\node_modules\ali-oss\lib\client.js:32:27)
at createOSSClient (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\dist\webpack:\flat-server\src\v1\controller\cloudStorage\alibabaCloud\Utils.ts:57:12)
at Object../src/v1/controller/cloudStorage/alibabaCloud/Utils.ts (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\dist\webpack:\flat-server\src\v1\controller\cloudStorage\alibabaCloud\Utils.ts:68:21)
at webpack_require (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\dist\webpack:\flat-server\webpack\bootstrap:19:1)
at Object../src/abstract/login/index.ts (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\dist\webpack:\flat-server\src\abstract\login\index.ts:7:1)
at webpack_require (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\dist\webpack:\flat-server\webpack\bootstrap:19:1)
at Object../src/v1/controller/login/platforms/LoginWechat.ts (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\dist\webpack:\flat-server\src\v1\controller\login\platforms\LoginWechat.ts:1:1)
at webpack_require (C:\Users\Valery-Jerome\Desktop\Agora2\flat-server\dist\webpack:\flat-server\webpack\bootstrap:19:1)

if you know how to do, I would be happy :-)

Jérôme

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking README.md's Docker command and setup instructions, then compare the referenced src/v1/thirdPartyService path and the build output with the current repository. Review the cloud-storage initialization around src/v1/controller/cloudStorage/alibabaCloud/Utils.ts and verify what configuration the README documents; done means the documented setup matches the repository and required credentials are explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, nodejs, typescript
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.