init

tiptopcoder · tiptopcoder · commit 32877f3b8cf7 · 2020-02-08T20:36:00.000-05:00
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# cra-template-next-express-typescript
+
+A template for Next.js application with Typescript and custom Express server.
diff --git a/package.json b/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "cra-template-next-express-typescript",
+  "version": "1.0.0",
+  "description": "The base Typescript NextJS with Express custom server",
+  "main": "template.json",
+  "keywords": [
+    "react",
+    "create-react-app",
+    "nextjs",
+    "express",
+    "typescript",
+    "template"
+  ],
+  "author": "Tien N. Nhan <tien@nnhan.com>",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 10"
+  },
+  "files": [
+    "template",
+    "template.json"
+  ]
+}
diff --git a/template.json b/template.json
@@ -0,0 +1,27 @@
+{
+  "dependencies": {
+    "express": "^4.17.1",
+    "next": "^9.2.1",
+    "react": "^16.12.0",
+    "react-dom": "^16.12.0"
+  },
+  "scripts": {
+    "dev": "nodemon",
+    "build": "yarn clean && yarn build:server && yarn build:next",
+    "start": "NODE_ENV=production node dist/index.js",
+    "build:server": "tsc --project tsconfig.build-server.json && babel server --out-dir dist --extensions \".ts\" --source-maps inline",
+    "build:next": "next build",
+    "clean": "rm -rf .next dist"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.8.4",
+    "@types/express": "^4.17.2",
+    "@types/node": "^13.7.0",
+    "@types/react": "^16.9.19",
+    "babel-plugin-module-resolver": "^4.0.0",
+    "nodemon": "^2.0.2",
+    "ts-node": "^8.6.2",
+    "tsconfig-paths": "^3.9.0",
+    "typescript": "^3.7.5"
+  }
+}
diff --git a/template/.babelrc b/template/.babelrc
@@ -0,0 +1,15 @@
+{
+  "presets": ["next/babel"],
+  "plugins": [
+    [
+      "module-resolver",
+      {
+        "root": ["./"],
+        "alias": {
+          "@src": "./src",
+          "@server": "./server"
+        }
+      }
+    ]
+  ]
+}
diff --git a/template/README.md b/template/README.md
@@ -0,0 +1,3 @@
+# cra-template-next-express-typescript
+
+A template for Next.js application with Typescript and custom Express server.
diff --git a/template/gitignore b/template/gitignore
@@ -0,0 +1,4 @@
+node_modules
+*.log
+.next
+dist
diff --git a/template/next-env.d.ts b/template/next-env.d.ts
@@ -0,0 +1,2 @@
+/// <reference types="next" />
+/// <reference types="next/types/global" />
diff --git a/template/nodemon.json b/template/nodemon.json
@@ -0,0 +1,6 @@
+{
+  "watch": ["server"],
+  "ext": "ts",
+  "ignore": ["server/tests/*"],
+  "exec": "ts-node -r tsconfig-paths/register --project tsconfig.server.json server/index.ts"
+}
diff --git a/template/package.json b/template/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "next-express-typescript",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "express": "^4.17.1",
+    "next": "^9.2.1",
+    "react": "^16.12.0",
+    "react-dom": "^16.12.0"
+  },
+  "scripts": {
+    "dev": "nodemon",
+    "build": "yarn clean && yarn build:server && yarn build:next",
+    "start": "NODE_ENV=production node dist/index.js",
+    "build:server": "tsc --project tsconfig.build-server.json && babel server --out-dir dist --extensions \".ts\" --source-maps inline",
+    "build:next": "next build",
+    "clean": "rm -rf .next dist"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.8.4",
+    "@types/express": "^4.17.2",
+    "@types/node": "^13.7.0",
+    "@types/react": "^16.9.19",
+    "babel-plugin-module-resolver": "^4.0.0",
+    "nodemon": "^2.0.2",
+    "ts-node": "^8.6.2",
+    "tsconfig-paths": "^3.9.0",
+    "typescript": "^3.7.5"
+  }
+}
diff --git a/template/public/index.html b/template/public/index.html
@@ -0,0 +1 @@
+<!-- Remove this file after create application -->
diff --git a/template/server/index.ts b/template/server/index.ts
@@ -0,0 +1,26 @@
+import express, { Request, Response } from "express";
+import next from "next";
+import routes from "./routes";
+
+const dev = process.env.NODE_ENV !== "production";
+const app = next({ dev });
+const handle = app.getRequestHandler();
+const port = process.env.PORT || 3000;
+
+(async () => {
+  try {
+    await app.prepare();
+    const server = express();
+    server.use("/api", routes);
+    server.all("*", (req: Request, res: Response) => {
+      return handle(req, res);
+    });
+    server.listen(port, (err?: any) => {
+      if (err) throw err;
+      console.log(`> Ready on localhost:${port}`);
+    });
+  } catch (e) {
+    console.log(e);
+    process.exit(1);
+  }
+})();
diff --git a/template/server/models/User.ts b/template/server/models/User.ts
@@ -0,0 +1,7 @@
+class User {
+  static getName(): string {
+    return "user";
+  }
+}
+
+export default User;
diff --git a/template/server/routes/index.ts b/template/server/routes/index.ts
@@ -0,0 +1,13 @@
+import express, { Request, Response } from "express";
+import User from "@server/models/User";
+const router = express.Router();
+
+router.get("/health", (req: Request, res: Response) => {
+  res.status(200).json({ apiHealth: true });
+});
+
+router.get("/user", (req: Request, res: Response) => {
+  res.status(200).json({ user: User.getName() });
+});
+
+export default router;
diff --git a/template/src/components/Test.tsx b/template/src/components/Test.tsx
@@ -0,0 +1,5 @@
+const Test = () => {
+  return <div>Test</div>;
+};
+
+export default Test;
diff --git a/template/src/index.tsx b/template/src/index.tsx
@@ -0,0 +1,3 @@
+/**
+ * Remove this file after create application
+ */
diff --git a/template/src/pages/_error.tsx b/template/src/pages/_error.tsx
@@ -0,0 +1,16 @@
+function Error({ statusCode }) {
+  return (
+    <p>
+      {statusCode
+        ? `An error ${statusCode} occurred on server`
+        : "An error occurred on client"}
+    </p>
+  );
+}
+
+Error.getInitialProps = ({ res, err }) => {
+  const statusCode = res ? res.statusCode : err ? err.statusCode : 404;
+  return { statusCode };
+};
+
+export default Error;
diff --git a/template/src/pages/index.tsx b/template/src/pages/index.tsx
@@ -0,0 +1,12 @@
+import Test from "@src/components/Test";
+
+const Index = () => {
+  return (
+    <div>
+      <div>Hello CRA NextJS Express Typescript</div>
+      <Test />
+    </div>
+  );
+};
+
+export default Index;
diff --git a/template/tsconfig.build-server.json b/template/tsconfig.build-server.json
@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.server.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "emitDeclarationOnly": true,
+    "declaration": true,
+    "noEmit": false,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["server"]
+}
diff --git a/template/tsconfig.json b/template/tsconfig.json
@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "baseUrl": ".",
+    "paths": {
+      "@src/*": ["./src/*"],
+      "@server/*": ["./server/*"]
+    }
+  },
+  "exclude": ["node_modules"],
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"]
+}
diff --git a/template/tsconfig.server.json b/template/tsconfig.server.json
@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs"
+  }
+}
diff --git a/template/yarn-error.log b/template/yarn-error.log
@@ -0,0 +1,36 @@
+Arguments: 
+  /Users/tiptopcoder/.nvm/versions/node/v12.10.0/bin/node /usr/local/Cellar/yarn/1.21.1/libexec/bin/yarn.js init
+
+PATH: 
+  /Users/tiptopcoder/Desktop/google-cloud-sdk/bin:/Users/tiptopcoder/.nvm/versions/node/v12.10.0/bin:/usr/local/opt/openssl/bin:/Users/tiptopcoder/.rbenv/shims:/usr/local/opt/php@7.2/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/share/dotnet:~/.dotnet/tools:/Library/Frameworks/Mono.framework/Versions/Current/Commands:/Applications/Wireshark.app/Contents/MacOS:/Applications/Xamarin Workbooks.app/Contents/SharedSupport/path-bin:/Users/tiptopcoder/Desktop/google-cloud-sdk/bin:/Users/tiptopcoder/.nvm/versions/node/v12.10.0/bin:/usr/local/opt/openssl/bin:/Users/tiptopcoder/.rbenv/shims:/usr/local/opt/php@7.2/bin:/Users/tiptopcoder/Library/Python/2.7/bin:/Users/tiptopcoder/Library/Android/sdk/emulator:/Users/tiptopcoder/Library/Android/sdk/tools:/Users/tiptopcoder/Library/Android/sdk/tools/bin:/Users/tiptopcoder/Library/Android/sdk/platform-tools:/Users/tiptopcoder/Library/Python/2.7/bin:/Users/tiptopcoder/Library/Android/sdk/emulator:/Users/tiptopcoder/Library/Android/sdk/tools:/Users/tiptopcoder/Library/Android/sdk/tools/bin:/Users/tiptopcoder/Library/Android/sdk/platform-tools
+
+Yarn version: 
+  1.21.1
+
+Node version: 
+  12.10.0
+
+Platform: 
+  darwin x64
+
+Trace: 
+  Error: canceled
+      at Interface.<anonymous> (/usr/local/Cellar/yarn/1.21.1/libexec/lib/cli.js:136925:13)
+      at Interface.emit (events.js:209:13)
+      at Interface._ttyWrite (readline.js:887:16)
+      at ReadStream.onkeypress (readline.js:191:10)
+      at ReadStream.emit (events.js:209:13)
+      at emitKeys (internal/readline/utils.js:433:14)
+      at emitKeys.next (<anonymous>)
+      at ReadStream.onData (readline.js:1153:36)
+      at ReadStream.emit (events.js:209:13)
+      at addChunk (_stream_readable.js:305:12)
+
+npm manifest: 
+  No manifest
+
+yarn manifest: 
+  No manifest
+
+Lockfile: 
+  No lockfile
diff --git a/template/yarn.lock b/template/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cra-template-next-express-typescript`
	`2`	`+`
	`3`	`+A template for Next.js application with Typescript and custom Express server.`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +node_modules
 +*.log
 +.next
 +dist
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+/// <reference types="next" />`
	`2`	`+/// <reference types="next/types/global" />`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!-- Remove this file after create application -->`