Refactor config

.env → .env.sample

@@ -4,4 +4,8 @@ secretKey='Putong Putong Putong'
 dbURL='mongodb://127.0.0.1:27017/oj'
 redisURL='redis://127.0.0.1:6379'
 
+title='Putong OJ'
+discussOnProblem=true
+semiRestful=false
+
 PORT=3000

.gitignore

@@ -1,10 +1,11 @@
 docker-compose.debug.yml
+.env
+data/*
+!data/example
 
 # customary
 .tern-project
 requests/
-data/*
-!data/1000
 migrations/db
 migrations/backup
 !migrations/db/.gitkeep

README.md

@@ -38,7 +38,13 @@ Currently Not available
 git clone https://github.com/acm309/PutongOJ.git PutongOJ
 ```
 
-2. compose up
+2. 配置环境变量
+
+```bash
+mv .env.sample .env
+```
+
+3. compose up
 
 ```bash
 docker-compose up
@@ -80,27 +86,22 @@ npm i -g pnpm
 pnpm i
 ```
 
-5. 尝试连接数据库
-
-设置环境变量
+5. 配置环境变量
 
 ```bash
-export redisURL='your redis url'
-export dbURL='your mongodb url'
+mv .env.sample .env
 ```
 
-更新 `config/index.js`
-
-```js
-const prod = {
-  port: 3000 // the port the application will listen on
-}
+```bash
+redisURL='your redis url'
+dbURL='your mongodb url'
+port=3000 #the port the application will listen on
 ```
 
 6. 下载静态文件和启动判题端
 
 ```bash
-node manager.js
+node manager.js setup
 ```
 
 `pm2.config.json` 会自动生成.

config/index.js

@@ -48,7 +48,7 @@ config.deploy = {
   adminInitPwd: 'kplkplkpl',
 }
 
-config.secretKey = process.env.secretKey
+config.secretKey = process.env.secretKey || ''
 
 config.dbURL = process.env.DBURL || process.env.dbURL // 之所以两个只为了兼容旧版命名；请优先采用后者
 
@@ -65,7 +65,7 @@ config.mail = {
 }
 
 config.port = Number.parseInt(
-  process.env.PORT,
+  process.env.PORT || 3000,
 )
 
 module.exports = config

config/website.js

@@ -1,7 +1,9 @@
+const process = require('node:process')
+
 module.exports = {
-  title: 'Putong OJ',
-  discussOnProblem: true,
-  semi_restful: false,
+  title: process.env.title || 'Putong OJ',
+  discussOnProblem: (process.env.discussOnProblem || 'false').toLocaleLowerCase() === 'true',
+  semi_restful: (process.env.semiRestful || 'false').toLocaleLowerCase() === 'true',
 }
 
 /**

manage.js

@@ -7,8 +7,11 @@ const range = require('lodash.range')
 // DO not upgrade execa to v6.0.0 as it is esm module
 const { command: execaCommand } = require('execa')
 const fetch = require('node-fetch')
+const { Command } = require('commander')
 const config = require('./config')
 
+const program = new Command()
+
 // download and initialize the judgers
 // start !
 
@@ -101,7 +104,7 @@ async function judgeSetup () {
   return fse.outputJSON('pm2.config.json', pm2config, { spaces: 2, EOL: '\n' })
 }
 
-async function staticFilesSetUp () {
+async function staticFilesSetup () {
   const res = await fetch('https://api.github.com/repos/acm309/PutongOJ-FE/releases')
   const json = await res.json()
   const url = json[0].assets[0].browser_download_url
@@ -112,19 +115,40 @@ async function staticFilesSetUp () {
   })
 }
 
-function main () {
-  return Promise.all([
-    judgeSetup(),
-    staticFilesSetUp(),
-  ])
+async function exampleProblemSetup () {
+  fse.move('data/example', 'data/1000')
 }
 
-main()
-  .then(() => {
-    console.log('ok')
-    process.exit(0)
+program.command('setup')
+  .action(() => {
+    console.log('setup...')
+    Promise.all([
+      exampleProblemSetup(),
+      judgeSetup(),
+      staticFilesSetup(),
+    ])
+      .then(() => {
+        console.log('ok')
+        process.exit(0)
+      })
+      .catch((err) => {
+        console.error(err)
+        process.exit(-1)
+      })
   })
-  .catch((err) => {
-    console.error(err)
-    process.exit(-1)
+
+program.command('update-fe')
+  .action(() => {
+    console.log('updating fe...')
+    staticFilesSetup()
+      .then(() => {
+        console.log('ok')
+        process.exit(0)
+      })
+      .catch((err) => {
+        console.error(err)
+        process.exit(-1)
+      })
   })
+
+program.parse()

package.json

@@ -24,7 +24,7 @@
     "deploy:init": "cross-env NODE_ENV=production node manage.js",
     "deploy:start": "npx pm2 start pm2.config.json",
     "pretest": "cross-env NODE_ENV=test node test/pretest.js",
-    "test": "cross-env NODE_ENV=test node test/pretest.js && nyc ava && node test/posttest.js",
+    "test": "cross-env-shell NODE_ENV=test \"node test/pretest.js && nyc ava && node test/posttest.js\"",
     "report": "nyc report --reporter=html",
     "posttest": "cross-env NODE_ENV=test node test/posttest.js",
     "lint": "eslint .",
@@ -67,6 +67,7 @@
   "devDependencies": {
     "ava": "^4.3.3",
     "codecov": "^3.8.3",
+    "commander": "^12.1.0",
     "eslint-config-standard": "^11.0.0",
     "eslint-plugin-import": "^2.30.0",
     "eslint-plugin-node": "^6.0.1",