Browse Source

Changed project name + added package metadata

rigwild 1 year ago
parent
commit
ef80359084
7 changed files with 43 additions and 11 deletions
  1. 1 1
      DOCUMENTATION/00-home.md
  2. 7 5
      README.md
  3. 1 1
      config.js
  4. 1 1
      docker-compose.yml
  5. 31 1
      package.json
  6. 1 1
      src/App.vue
  7. 1 1
      src/store/index.js

+ 1 - 1
DOCUMENTATION/00-home.md

@@ -1,4 +1,4 @@
-# Antoine_Internship
+# SIN3D
 
 ## Summary
 

+ 7 - 5
README.md

@@ -1,10 +1,12 @@
-# Antoine_Internship
+# SIN3D
+> Synthesis Image Noise Detection on Distributed Data
+
 A web app to collect data on noise detection by humans on images.
 
 ## Download project
 ```sh
-git clone https://gogs.univ-littoral.fr/Prise3D/Antoine_Internship.git
-cd Antoine_Internship
+git clone https://gogs.univ-littoral.fr/Prise3D/SIN3D.git
+cd SIN3D
 ```
 
 ## Run as a Docker instance
@@ -16,7 +18,7 @@ Use the following environment variables to configure the application.
 | `PORT` | `5000` | The port used by the started application |  ✅  | ✅ |
 | `SERVE_CLIENT` | `true` | Should the server serve client (Fully local application) |  ✅  | ⬜️ |
 | `IMAGES_PATH` | `./images` | The directory where the images are stored (absolute path if changed ⚠️) |  ✅  | ⬜️ |
-| `MONGO_URI` | `mongodb://localhost/webexpe` | MongoDB database connection URI |  ✅  | ⬜️ |
+| `MONGO_URI` | `mongodb://localhost/sin3d` | MongoDB database connection URI |  ✅  | ⬜️ |
 
 Configure more deeply the way the app works by modifying *[config.js](config.js)*.
 
@@ -25,7 +27,7 @@ Configure more deeply the way the app works by modifying *[config.js](config.js)
 | `apiPrefix` | `/api` | The url prefix for the API |
 | `imageServedUrl` | `/api/images` | The url prefix from where the images are served |
 | `serverPort` | `5000` | The port used by the server |
-| `mongoDatabaseURI` | `mongodb://localhost/webexpe` | MongoDB database connection URI |
+| `mongoDatabaseURI` | `mongodb://localhost/sin3d` | MongoDB database connection URI |
 | `imagesPath` | `./images` | The directory where the images are stored |
 | `serveClient` | `true` | Should the server serve client files from the `/dist` directory |
 | `fileNameConvention` | `/^(.*)?_([0-9]{2,})\.(.*)$/` | File name convention for images |

+ 1 - 1
config.js

@@ -16,7 +16,7 @@ export const imageServedUrl = apiPrefix + '/images'
 export const serverPort = parseInt(process.env.PORT, 10) || 5000
 
 // MongoDB database connection URI
-export const mongoDatabaseURI = process.env.MONGO_URI || 'mongodb://localhost:27017/webexpe'
+export const mongoDatabaseURI = process.env.MONGO_URI || 'mongodb://localhost:27017/sin3d'
 
 // The directory where the images are stored
 export const imagesPath = TEST_MODE

+ 1 - 1
docker-compose.yml

@@ -26,7 +26,7 @@ services:
             NODE_ENV: "production"
             SERVE_CLIENT: "${SERVE_CLIENT:-true}"
             PORT: "5000"
-            MONGO_URI: "${MONGO_URI:-mongodb://mongo:27017/webexpe}"
+            MONGO_URI: "${MONGO_URI:-mongodb://mongo:27017/sin3d}"
         links:
             - mongo
         volumes:

+ 31 - 1
package.json

@@ -1,7 +1,34 @@
 {
-  "name": "expe-web",
+  "name": "sin3d",
+  "description": "Synthesis Image Noise Detection on Distributed Data",
   "version": "0.2.8",
   "private": true,
+  "keywords": [
+    "noise",
+    "detection",
+    "synthesis image",
+    "distributed",
+    "data",
+    "web",
+    "experiment"
+  ],
+  "directories": {
+    "doc": "./DOCUMENTATION"
+  },
+  "homepage": "https://gogs.univ-littoral.fr/Prise3D/SIN3D",
+  "author": "Antoine Sauvage <contact@asauvage.fr> (https://asauvage.fr/)",
+  "contributors": [
+    "Jérôme Buisine <contact@jeromebuisine.fr> (https://jeromebuisine.fr/)",
+    "Samuel Delepoulle <delepoulle@lisic.univ-littoral.fr>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://gogs.univ-littoral.fr/Prise3D/SIN3D.git"
+  },
+  "bugs": {
+    "url": "https://gogs.univ-littoral.fr/Prise3D/SIN3D/issues"
+  },
+  "license": "MIT",
   "scripts": {
     "server:start": "node -r esm index.js",
     "server:start:no-delete-extracts": "node -r esm index.js --no-delete",
@@ -59,6 +86,9 @@
       "autoprefixer": {}
     }
   },
+  "engines": {
+    "node": ">= 8.30.0"
+  },
   "browserslist": [
     "> 1%",
     "last 2 versions",

+ 1 - 1
src/App.vue

@@ -48,7 +48,7 @@
       <!-- Top bar -->
       <v-toolbar app fixed clipped-left>
         <v-toolbar-side-icon @click.stop="drawer = !drawer" />
-        <v-toolbar-title>Web experiment</v-toolbar-title>
+        <v-toolbar-title>SIN3D</v-toolbar-title>
       </v-toolbar>
       <!--/ Top bar -->
     </div>

+ 1 - 1
src/store/index.js

@@ -10,7 +10,7 @@ Vue.use(Vuex)
 
 const vuexLocal = new VuexPersistence({
   storage: window.localStorage,
-  key: 'webexpe-state',
+  key: 'sin3d-state',
   reducer: state => ({
     customLinkData: state.customLinkData,
     uuid: state.uuid,