Merge pull request #296 from groodt/groodt-nextjs-folderstructure

Refactor folder structure
nteract · Jun 10, 2020 · c03d5bb · c03d5bb
2 parents 3a7db09 + 38c9827
commit c03d5bb
Show file tree

Hide file tree

Showing 46 changed files with 25 additions and 24 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -3,29 +3,21 @@
 ##################################
 FROM node:14 as build
 
-RUN mkdir -p /opt/build;
+RUN mkdir -p /opt/build
 
 WORKDIR /opt/build
 
-# Would be a bit simpler if the code was inside a top-level src folder
-COPY ./backend ./backend
-COPY ./components ./components
-COPY ./pages ./pages
-COPY ./public ./public
-COPY ./shims ./shims
-COPY ./transforms ./transforms
+COPY ./src ./src
 COPY [ \
   "babel.config.js", \
-  "frontend.js", \
   "next.config.js", \
   "package.json", \
-  "theme.js", \
   "yarn.lock", \
   "./" \
 ]
 
-RUN yarn install \
-  && yarn build
+RUN yarn install && \
+  yarn build
 
 ##################################
 # Dependencies
@@ -40,15 +32,21 @@ RUN DEBIAN_FRONTEND=noninteractive \
   libpango1.0-dev \
   libjpeg-dev \
   libgif-dev \
-  librsvg2-dev
+  librsvg2-dev && \
+  \
+  rm -rf /var/lib/apt/lists/*
 
 ENV NODE_ENV='production'
 
-RUN mkdir -p /opt/build;
+RUN mkdir -p /opt/build
 
 WORKDIR /opt/build
 
-COPY --from=build [ "/opt/build/package.json", "/opt/build/yarn.lock", "./" ]
+COPY --from=build [ \
+  "/opt/build/package.json", \
+  "/opt/build/yarn.lock", \
+  "./" \
+]
 
 RUN yarn install --production=true
 
@@ -64,12 +62,11 @@ RUN chmod +x /tini
 
 ENV NODE_ENV='production'
 
-RUN mkdir -p /opt/app;
+RUN mkdir -p /opt/app
 
 WORKDIR /opt/app
 
 COPY --from=build /opt/build/.next /opt/app/.next
-COPY --from=build /opt/build/frontend.js /opt/app/
 COPY --from=build /opt/build/lib /opt/app/lib
 COPY --from=build /opt/build/public /opt/app/public
 COPY --from=dependencies /opt/build/node_modules /opt/app/node_modules

diff --git a/package.json b/package.json
@@ -10,13 +10,16 @@
     "start": "NODE_ENV=production node lib/index.js",
     "build": "npm run build:all",
     "build:frontend-for-production": "next build",
-    "build:server": "babel backend -d lib",
+    "build:server": "babel src -d lib",
     "build:all": "npm run build:server && npm run build:frontend-for-production",
     "prepublishOnly": "npm run build:all",
     "test": "jest"
   },
   "bin": {
-    "commuter": "bin.js"
+    "commuter": "lib/bin.js"
+  },
+  "jest": {
+    "testRegex": "tests"
   },
   "repository": "nteract/nteract",
   "keywords": [

diff --git a/backend/config.js → src/backend/config.js b/backend/config.js → src/backend/config.js
diff --git a/backend/content-providers/gcs/contents.js → ...backend/content-providers/gcs/contents.js b/backend/content-providers/gcs/contents.js → ...backend/content-providers/gcs/contents.js
diff --git a/backend/content-providers/gcs/files.js → src/backend/content-providers/gcs/files.js b/backend/content-providers/gcs/files.js → src/backend/content-providers/gcs/files.js
diff --git a/backend/content-providers/gcs/gcs.js → src/backend/content-providers/gcs/gcs.js b/backend/content-providers/gcs/gcs.js → src/backend/content-providers/gcs/gcs.js
diff --git a/backend/content-providers/gcs/index.js → src/backend/content-providers/gcs/index.js b/backend/content-providers/gcs/index.js → src/backend/content-providers/gcs/index.js
diff --git a/backend/content-providers/local/contents.js → ...ckend/content-providers/local/contents.js b/backend/content-providers/local/contents.js → ...ckend/content-providers/local/contents.js
diff --git a/backend/content-providers/local/files.js → src/backend/content-providers/local/files.js b/backend/content-providers/local/files.js → src/backend/content-providers/local/files.js
diff --git a/backend/content-providers/local/fs.js → src/backend/content-providers/local/fs.js b/backend/content-providers/local/fs.js → src/backend/content-providers/local/fs.js
diff --git a/backend/content-providers/local/index.js → src/backend/content-providers/local/index.js b/backend/content-providers/local/index.js → src/backend/content-providers/local/index.js
diff --git a/backend/content-providers/s3/contents.js → src/backend/content-providers/s3/contents.js b/backend/content-providers/s3/contents.js → src/backend/content-providers/s3/contents.js
diff --git a/backend/content-providers/s3/files.js → src/backend/content-providers/s3/files.js b/backend/content-providers/s3/files.js → src/backend/content-providers/s3/files.js
diff --git a/backend/content-providers/s3/index.js → src/backend/content-providers/s3/index.js b/backend/content-providers/s3/index.js → src/backend/content-providers/s3/index.js
diff --git a/backend/content-providers/s3/s3.js → src/backend/content-providers/s3/s3.js b/backend/content-providers/s3/s3.js → src/backend/content-providers/s3/s3.js
diff --git a/...-providers/elasticsearch/elasticSearch.js → ...-providers/elasticsearch/elasticSearch.js b/...-providers/elasticsearch/elasticSearch.js → ...-providers/elasticsearch/elasticSearch.js
diff --git a/...iscovery-providers/elasticsearch/index.js → ...iscovery-providers/elasticsearch/index.js b/...iscovery-providers/elasticsearch/index.js → ...iscovery-providers/elasticsearch/index.js
diff --git a/backend/discovery-providers/none/index.js → ...backend/discovery-providers/none/index.js b/backend/discovery-providers/none/index.js → ...backend/discovery-providers/none/index.js
diff --git a/backend/resources/commuter.es.mapping.json → ...ackend/resources/commuter.es.mapping.json b/backend/resources/commuter.es.mapping.json → ...ackend/resources/commuter.es.mapping.json
diff --git a/backend/resources/generateMapping.js → src/backend/resources/generateMapping.js b/backend/resources/generateMapping.js → src/backend/resources/generateMapping.js
diff --git a/...nd/resources/nteract.metadata.schema.json → ...nd/resources/nteract.metadata.schema.json b/...nd/resources/nteract.metadata.schema.json → ...nd/resources/nteract.metadata.schema.json
diff --git a/backend/routes/api/index.js → src/backend/routes/api/index.js b/backend/routes/api/index.js → src/backend/routes/api/index.js
diff --git a/backend/routes/index.js → src/backend/routes/index.js b/backend/routes/index.js → src/backend/routes/index.js
diff --git a/backend/server.js → src/backend/server.js b/backend/server.js → src/backend/server.js
diff --git a/bin.js → src/bin.js b/bin.js → src/bin.js
@@ -2,4 +2,4 @@
 
 process.env.NODE_ENV = "production";
 
-require("./lib/index.js");
+require("./index.js");
diff --git a/components/body.js → src/components/body.js b/components/body.js → src/components/body.js
diff --git a/components/browse-header.js → src/components/browse-header.js b/components/browse-header.js → src/components/browse-header.js
diff --git a/components/contents/csv.js → src/components/contents/csv.js b/components/contents/csv.js → src/components/contents/csv.js
diff --git a/components/contents/directory-listing.js → src/components/contents/directory-listing.js b/components/contents/directory-listing.js → src/components/contents/directory-listing.js
diff --git a/components/contents/html.js → src/components/contents/html.js b/components/contents/html.js → src/components/contents/html.js
diff --git a/components/contents/index.js → src/components/contents/index.js b/components/contents/index.js → src/components/contents/index.js
diff --git a/components/contents/json.js → src/components/contents/json.js b/components/contents/json.js → src/components/contents/json.js
diff --git a/components/contents/zeppelin.js → src/components/contents/zeppelin.js b/components/contents/zeppelin.js → src/components/contents/zeppelin.js
diff --git a/components/header.js → src/components/header.js b/components/header.js → src/components/header.js
diff --git a/frontend.js → src/frontend.js b/frontend.js → src/frontend.js
@@ -1,11 +1,12 @@
 // Note: this module must remain compatible with the ECMAScript version of the
 // Server as it does _not_ get transpiled
 const next = require("next");
+const path = require("path");
 
 const dev = process.env.NODE_ENV !== "production" && !process.env.NOW;
 
 function createNextApp() {
-  const app = next({ dev, dir: __dirname });
+  const app = next({ dev, dir: path.join(__dirname, "..") });
   const handle = app.getRequestHandler();
 
   return {

diff --git a/backend/index.js → src/index.js b/backend/index.js → src/index.js
@@ -1,7 +1,7 @@
 // @flow
 const log = require("log");
 
-const createServer = require("./server");
+const createServer = require("./backend/server");
 
 createServer()
   .then(server => {

diff --git a/pages/_document.js → src/pages/_document.js b/pages/_document.js → src/pages/_document.js
diff --git a/pages/discover.js → src/pages/discover.js b/pages/discover.js → src/pages/discover.js
diff --git a/pages/index.js → src/pages/index.js b/pages/index.js → src/pages/index.js
diff --git a/pages/view.js → src/pages/view.js b/pages/view.js → src/pages/view.js
diff --git a/shims/ajax.js → src/shims/ajax.js b/shims/ajax.js → src/shims/ajax.js
diff --git a/theme.js → src/theme.js b/theme.js → src/theme.js
diff --git a/transforms/PlotlyTransform.js → src/transforms/PlotlyTransform.js b/transforms/PlotlyTransform.js → src/transforms/PlotlyTransform.js
diff --git a/transforms/index.js → src/transforms/index.js b/transforms/index.js → src/transforms/index.js
diff --git a/__tests__/routesUtil-spec.js → tests/routesUtil-spec.js b/__tests__/routesUtil-spec.js → tests/routesUtil-spec.js
@@ -1,5 +1,5 @@
 // @flow
-const isDir = require("./../backend/content-providers/s3/contents").isDir;
+const isDir = require("./../src/backend/content-providers/s3/contents").isDir;
 
 describe("Routes util tests", () => {
   test("returns isDir true", () => {

diff --git a/__tests__/s3test.js → tests/s3test.js b/__tests__/s3test.js → tests/s3test.js
@@ -2,7 +2,7 @@
 jest.mock("aws-sdk/clients/s3");
 const awsMock = require("aws-sdk/clients/s3");
 
-const s3Service = require("./../backend/content-providers/s3/s3");
+const s3Service = require("./../src/backend/content-providers/s3/s3");
 
 describe("Test S3 service", () => {
   test("getObject returns notebook content", done => {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		process.env.NODE_ENV = "production";

		require("./lib/index.js");
		require("./index.js");