Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xizon/fullstack-nextjs-app-template
A full-stack sample web application based on Next.js that creates a simple whole-website architecture
https://github.com/xizon/fullstack-nextjs-app-template
docker-images express expressjs next nextjs nextjs-example nextjs-starter nextjs-template pm2 react reactjs server-side-rendering ssr typescript
Last synced: about 8 hours ago
JSON representation
A full-stack sample web application based on Next.js that creates a simple whole-website architecture
- Host: GitHub
- URL: https://github.com/xizon/fullstack-nextjs-app-template
- Owner: xizon
- License: mit
- Created: 2022-10-30T01:48:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-06T04:17:14.000Z (7 months ago)
- Last Synced: 2024-04-06T05:23:39.979Z (7 months ago)
- Topics: docker-images, express, expressjs, next, nextjs, nextjs-example, nextjs-starter, nextjs-template, pm2, react, reactjs, server-side-rendering, ssr, typescript
- Language: TypeScript
- Homepage: https://xizon.github.io/fullstack-nextjs-app-template/public/assets/images/screenshot.jpg
- Size: 3.78 MB
- Stars: 61
- Watchers: 3
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Full-Stack Next.js Application Template
This repository is a full-stack sample web application based on Next.js that creates a simple whole-website architecture, and provides the foundational services, components, and plumbing needed to get a basic web application up and running.
## Table of Contents
* [Scheme](#scheme)
* [File Structures](#file-structures)
* [Getting Started](#getting-started)
* [Further Help](#further-help)
* - [(π Incremental Guide) Migrating from Pages Router to App Router](#---incremental-guide-migrating-from-pages-router-to-app-router)
* - [Deploy on Custom Server](#--deploy-on-custom-server)
* - [Deploy on Custom Server](#--deploy-on-custom-server)
* - [Node.js Port 3000 already in use but it actually isn't?](#--nodejs-port-3000-already-in-use-but-it-actually-isnt)
* - [Change the Favicon](#--change-the-favicon)
* - [Customize Menu](#--customize-menu)
* - [Set port in next.js](#--set-port-in-nextjs)
* - [Set basePath for a static exported](#--set-basepath-for-a-static-exported)
* - [Site URL (Root Directory) Configurations](#--site-url-root-directory-configurations)
* - [Deploy Using Docker (build a single next.js program image)](#--deploy-using-docker-build-a-single-nextjs-program-image)
* - [Deploy Using Docker (Build composite image that include other custom images)](#--deploy-using-docker-build-composite-image-that-include-other-custom-images)
* - [Deploy Using Docker (Common Load-balancing Solutions of Socket.io Issue)](#--deploy-using-docker-common-load-balancing-solutions-of-socketio-issue)
* - [Installation Error or Unable To Run](#--installation-error-or-unable-to-run)
* [Contributing](#contributing)
* [Supported development environment](#supported-development-environment)
* [Changelog](#changelog)
* [Licensing](#licensing)
## Scheme
List my progress here:
| Function Block | Supports |
| --- | --- |
| π Pages Router Demo Template | β
ππΌ Enabling it requires renaming the folder [@pages](@pages) to `pages`, and deleting [app](app). |
| π App Router Demo Template | β
ππΌ Default |
| π Exporting Pure HTML Static Files (**.html**) | β
ππΌ run `npm run export` and `npm run export:fix`|
| HTTP Navigation (SSR & Async) | β
|
| Multiple API Constructs | β
|
| Parameter Acquisition | β
|
| Pagination | β
|
| Basic Importing Methods for Components | β
|
| Authorization | β
|
| Login | β
|
| Network Requests | β
|
| API Demo | β
|
| CURD Demo | β
|
| JWT Demo | β
|
| File Import | β
|
| SEO Premium | β
|
| Static Pages | β
|
| Incremental Static Regeneration | β
|
| Remote Download | β
|
| Fully Static HTML Files Generation | β
|
| Custom Server | β
|
| Custom Hooks (auth, redux, draggable, keypress etc.) | β
|
| Frontend Page Interacts With Node | β
|
| Alias Support | β
|
| Local PHP Service Association | β
|
| Server Deployment | β
|
| Deploy Using Docker | β
|
| Redux Supplement (for navigation) | β
|
| Redux SSR (for homepage navigation) | β
|
| WebSocket Support via `socket.io` | β
|
| Additional Node.js Services | β
|
| Request Cache Demo | β
|
| Authentication of Microservices | β
|
| Markdown Render Demo | β
|
| NestJS Support | π |
| π End-to-end typesafe API (gRPC) | β οΈ *unbundled* ππΌ [gRPC Getting Started](https://github.com/xizon/grpc-getting-started) |
| π React UI Components Libraries | β οΈ *unbundled* ππΌ [Funda UI](https://github.com/xizon/funda-ui) |
| π Nextjs Doc Template | β οΈ *unbundled* ππΌ [Nextjs Doc Template](https://github.com/xizon/nextjs-doc-template) |
## File Structures
```sh
fullstack-nextjs-app-template/
βββ README.md
βββ CHANGELOG.md
βββ LICENSE
βββ next.config.js
βββ server.js
βββ ecosystem.config.js
βββ middleware.ts
βββ tsconfig.json
βββ package-lock.json
βββ package.json
βββ .dockerignore
βββ Dockerfile
βββ docker-compose.yml
βββ out/ # Folder generated by export command which contains the HTML/CSS/JS assets for your application
βββ backend/
β βββ server-php.js # test server
β βββ ... # All other files are optional
βββ scripts/ # Node Script Library
βββ public/ # Contains static resources, PHP remote test files, .md files for markdown rendering, etc.
βββ app/ # App Router Demo Template
βββ @pages/ # Pages Router Demo Template (Enabling it requires renaming the folder `@pages` to `pages`, and deleting `app`.)
β βββ api/
β βββ *.tsx
βββ src/
β βββ config/
β βββ data/
β βββ contexts/
β βββ interfaces/
β βββ components/
β βββ styles/
β βββ utils/
β βββ store/
βββ
```
## Getting Started
Make sure if NODEJS is installed on your computer.
### Install Dependencies:
```sh
$ npm install
```
It will create `node_module` folder in this all dependency files will be install with this command.
### Update Next.js:
```sh
$ npm i next@latest react@latest react-dom@latest eslint-config-next@latest
```
check out [here](https://nextjs.org/docs/pages/building-your-application/upgrading)
### Run Project in development mode:
```sh
$ npm run dev
```
With is command file will be compiled and it will be loaded on local server [http://localhost:3000](http://localhost:3000).
### Production Build :
```sh
$ npm run build
```
**Note:** Defer generating all pages on-demand by this command. You can have faster builds by generating all pages on-demand for previews (but not production builds). This is helpful for sites with hundreds/thousands of static pages.
```sh
$ npm run build:static
```
This build mode will generate static data.
### Start a Next.js production server:
```sh
$ npm run start
```
### Start the PHP server independently:
Please install php on your computer first.
```sh
$ npm run action:phpserver
```
Please use a PHP server environment with a local port of 4000, check the file at `./backend/server-php.js`
### Deploy node server on hosting server:
**production mode:**
```sh
$ npm run build # this command must be run first
$ npm run deploy:prod
```
**development mode:**
```sh
$ npm run deploy:dev
```
*(If it doesn't work because of Node permission, use the following [commands](#deploy-on-custom-server-commands))*
### Stop the existing deployments
```sh
$ npm run destroy
```
### Export your Next.js application to static HTML
FIrst, you need to enable [Static Exports](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports).
> [!WARNING]
> [ISR](https://nextjs.org/docs/pages/building-your-application/rendering/incremental-static-regeneration) cannot be used with "output: export".
**Step 1. generate static resources:**
```sh
$ npm run export
```
**Step 2. fix name for HTML files:**
```sh
$ npm run export:fix
```
**Step 3. preview the static site**
Then, test the generated static website (the HTML static website is located in the directory `.out/`). Access using the URL [http://localhost:12345](http://localhost:12345)
```sh
$ npm run export:test
```
## Further Help
ππΌ (π Incremental Guide) Migrating from Pages Router to App Router
Check out [this article](https://clerk.com/blog/migrating-pages-router-to-app-router-an-incremental-guide)
### [0\. Create the /app directory](#0-create-the-app-directory)
Before you can get started with the App Router, you will first need to create a **/app** directory as a sibling to your **/pages** directory.
### [1\. Migrate /pages/\_document to the App Router](#1-migrate-pages-document-to-the-app-router)
If you have a [Custom Document](https://nextjs.org/docs/pages/building-your-application/routing/custom-document) at **/pages/\_document.tsx**, it should look something like this, though likely with some customization:
/pages/\_document.tsx
```js
import { Html, Head, Main, NextScript } from 'next/document'
export default function Document() {
return (
)
}
```
We need to convert this into a [Root Layout](https://nextjs.org/docs/app/building-your-application/routing/pages-and-layouts#root-layout-required), which can be treated as a 1-to-1 corollary to a Custom Document:
1. Clone **/pages/\_document.tsx** into **/app/layout.tsx**. We will keep both files since we're doing incremental adoption. (If you use .jsx that is no problem, you can use layout.jsx instead)
2. Remove the **next/document** import line entirely
3. Replace `` and `` with the lowercase, HTML equivalent `` and ``. For accessibility, it's best to add a language to your opening tag, like ``
4. Replace `` and `` with the lowercase, HTML equivalent `` and ``. If you only have a self-closing `{children}
)
}
```
**Important: /app/layout.tsx is required** in the **/app** directory. If you do not have a Custom Document, you can copy-paste the above sample directly into **/app/layout.tsx**.
### [2\. Migrate /pages/\_app.tsx to the App Router](#2-migrate-pages-app-tsx-to-the-app-router)
**Note:** If you do not have a file at **/pages/\_app.tsx** you can skip to Step 3.
If you have a [Custom App](https://nextjs.org/docs/pages/building-your-application/routing/custom-app) at **/pages/\_app.tsx**, it should look something like this, though likely with some customization:
/pages/\_app.tsx
```js
import type { AppProps } from 'next/app'
export default function MyApp({ Component, pageProps }: AppProps) {
return
}
```
The **/app** directory does not have a 1-to-1 corollary for a Custom App, but it can easily be expressed in the new structure:
1. Clone **/pages/\_app.tsx** into **/app/ClientLayout.tsx**. We will keep both files since we're doing incremental adoption. (If you use .jsx that is no problem, you can use ClientLayout.jsx instead)
2. Add a new line to the top of the file that reads `"use client"` (with the quotes)
3. Replace the default export's function signature. Instead of taking `Component` and `pageProps` arguments, it should only take a `children` argument. For Typescript users, `children` is of type `React.ReactNode`.
4. Replace `` with `<>{children}>`, or just `{children}` if you have another wrapping element
5. If there are any remaining references to `pageProps`, please comment them out for now, and revisit them on a page-by-page basis. Next.js has added a new [metadata API](https://nextjs.org/docs/app/building-your-application/optimizing/metadata) that should normally be used in place of accessing `pageProps` here
6. We recommend changing the default export name from `MyApp` to `ClientLayout`. It is not strictly necessary, but it is more conventional
When complete, **/app/ClientLayout.tsx** should look more like this, plus your customizations:
/app/ClientLayout.tsx
```js
'use client'
export default function ClientLayout({ children }: { children: React.ReactNode }) {
return <>{children}>
}
```
Now, this is where things get a little different:
* In the Pages Router, **/pages/\_app.tsx** is a "magic" layout file that is automatically added to the React tree
* In the App Router, the only layout file automatically added to the React tree is the Root Layout from Step 1. So, we will need to manually import and mount our `ClientLayout` inside **/app/layout.tsx**
Open **/app/layout.tsx**, import ClientLayout, and use it to wrap `{children}`. When complete, your Root Layout should look like this, plus any customizations from Step 1:
/app/layout.tsx
```js
import ClientLayout from './ClientLayout'
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
{children}
)
}
```
### [3\. Migrate each page to the App Router](#3-migrate-each-page-to-the-app-router)
Now that your layout has been copied into the App Router, it's time to start migrating your pages one-by-one. There will be a few steps for each page:
1. Create a directory for the page
2. Create one file to handle data fetching
3. Create one file to render the page
4. Remove the Pages Router page
For the avoidance of doubt: yes, we will be splitting your Pages Router page into two files: one for data fetching and one for rendering.
#### [3.1. Create a directory for the page](#3-1-create-a-directory-for-the-page)
Both the Pages Router and the App Router are "filesystem routers," but they are organized slightly differently. In the App Router, each page gets its own directory. Here is how to determine the directory name:
* If your file is named **index.tsx**, create the same parent directory structure
* For **/pages/foo/index.tsx**, create **/app/foo**
* For **/pages/index.tsx**, you already have **/app**
* If your file is **not** named **index.tsx**, create a directory with that filename
* For **/pages/bar.tsx**, create **/app/bar**
* For **/pages/baz/\[slug\].tsx**, create **/app/baz/\[slug\]**
* For **/pages/baz/\[\[...slug\].tsx**, create **/app/baz/\[\[...slug\]\]**
#### [3.2. Create a file to handle data fetching](#3-2-create-a-file-to-handle-data-fetching)
Inside your page directory, create a file called **page.tsx** to handle data fetching. Copy-paste the following snippet as the foundation of this file (**Note:** we will create **ClientPage.tsx** in 3.3.):
page.tsx
```js
import ClientPage from './ClientPage'
export default async function Page() {
return
}
```
If your Pages Router file does not have any data fetching, you can continue on to the next step. Otherwise, find your data fetcher below to learn how it can be migrated:
**Migrating getStaticProps to the App Router**
Consider the following is your implementation of `getStaticProps`:
```js
export const getStaticProps: GetStaticProps = async () => {
const res = await fetch('https://api.github.com/repos/vercel/next.js')
const repo = await res.json()
return { props: { repo } }
}
```
To migrate this with as little modification as possible, we will:
1. Copy-paste `getStaticProps` into **page.tsx**
2. Call `getStaticProps` from within our `Page` component
3. Add `export const dynamic = "force-static"` so the page data is fetched once and cached, not refetched on every load
4. Pass the result to our (not yet created) `ClientPage` component
Here is the end result:
page.tsx
```js
import ClientPage from './ClientPage'
export const getStaticProps: GetStaticProps = async () => {
const res = await fetch('https://api.github.com/repos/vercel/next.js')
const repo = await res.json()
return { props: { repo } }
}
export const dynamic = 'force-static'
export default async function Page() {
const { props } = await getStaticProps()
return
}
```
**Migrating getServerSideProps to the App Router**
Consider the following implementation of `getServerSideProps`:
```js
import { getAuth } from '@clerk/nextjs/server'
export const getServerSideProps: GetServerSideProps = async ({ req }) => {
const { userId } = getAuth(req)
const res = await fetch('https://api.example.com/foo', {
headers: {
Authorization: `Bearer: ${process.env.API_KEY}`,
},
})
const data = await res.json()
return { props: { data } }
}
```
To migrate this with as little modification as possible, we will:
1. Copy-paste `getServerSideProps` into **page.tsx**
2. Add `export const dynamic = "force-dynamic"` so the page data is refetched on every load, [reference docs](https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating)
3. Replace any usage of `req` with the App Router equivalent
4. Our example uses [Clerk for authentication](/solutions/nextjs-authentication), so the end result will replace this line with its App Router-compatible replacement
5. Replace `req.headers` with the new [headers() helper](https://nextjs.org/docs/app/api-reference/functions/headers)
6. Replace `req.cookies` with the new [cookies() helper](https://nextjs.org/docs/app/api-reference/functions/headers)
7. Replace `req.url.searchParams` with the new [searchParams helper](https://nextjs.org/docs/app/api-reference/file-conventions/page#searchparams-optional)
8. Replace any Dynamic Route segment usage with the new [params helper](https://nextjs.org/docs/app/api-reference/file-conventions/page#params-optional)
9. Call `getServerSideProps` from within our `Page` component
10. Pass the result to our (not yet created) `ClientPage` component
Here is the end result:
page.tsx
```js
import { auth } from '@clerk/nextjs'
import ClientPage from './ClientPage'
export const getServerSideProps: GetServerSideProps = async () => {
const { userId } = auth()
const res = await fetch('https://api.example.com/foo', {
headers: {
Authorization: `Bearer: ${process.env.API_KEY}`,
},
})
const data = await res.json()
return { props: { data } }
}
export const dynamic = 'force-dynamic'
export default async function Page() {
const { props } = await getServerSideProps()
return
}
```
**Migrating getStaticPaths to the App Router**
Consider the following implementation of `getStaticPaths`:
```js
export async function getStaticPaths() {
return {
paths: [{ params: { id: '1' } }, { params: { id: '2' } }],
}
}
```
In the App Router, this implementation barely changes. It's simply given a new name (`generateStaticParams`) and the output is transformed to something simpler. That means you can use your old implementation directly, and simply transform the output.
Here is the end result β we included an example of how it can be used in tandem with `getStaticProps`:
page.tsx
```js
import ClientPage from './ClientPage'
export async function getStaticPaths() {
return {
paths: [{ params: { id: '1' } }, { params: { id: '2' } }],
}
}
export async function generateStaticParams() {
const staticPaths = await getStaticPaths()
return staticPaths.paths.map((x) => x.params)
}
export const getStaticProps: GetStaticProps = async ({ params }) => {
const res = await fetch(`https://api.example.com/foo/${params.id}`)
const data = await res.json()
return { props: { data } }
}
export default async function Page({ params }) {
const { props } = await getStaticProps({ params })
return
}
```
#### [3.3. Create a file to render the page](#3-3-create-a-file-to-render-the-page)
Now that data fetching is ready, we need to configure the rendering. To accomplish this:
* Copy your original Pages Router page into **ClientPage.tsx**
* Remove any data fetching code, since it now lives in **page.tsx**
That's it! We have already configured **page.tsx** to mount this file and pass props, so it should be working.
#### [3.4. Remove the Pages Router page](#3-4-remove-the-pages-router-page)
Now that your page is ready in the App Router, you can delete the old Pages Router variant.
[MORE: App Router Incremental Adoption Guide](https://nextjs.org/docs/app/building-your-application/upgrading/app-router-migration)
ππΌ Deploy on Custom Server
> π Note: Using server.js may cause an error during [HMR] restart (first loading of the client):
> *WebSocket connection to 'ws://localhost:3000/_next/webpack-hmr' failed:* --> *InvalidArgumentError: invalid upgrade header*
> You can ignore it.
### π£ (Step 1) Create a file as the server startup entry
Create a new file `server.js` (do not use `.ts`) at the same level as your `pages` directory. Take a look at the following example of a custom server:
```js
const { createServer } = require('http');
const { parse } = require('url');
const next = require('next');
let dev = process.env.NODE_ENV !== 'production';
dev = false; // need run `npm run build` first
const hostname = 'localhost';
const port = 3000;
// when using middleware `hostname` and `port` must be provided below
const app = next({ dev, hostname, port });
const handle = app.getRequestHandler();
app.prepare().then(() => {
createServer(async (req, res) => {
try {
// Be sure to pass `true` as the second argument to `url.parse`.
// This tells it to parse the query portion of the URL.
const parsedUrl = parse(req.url, true)
const { pathname, query } = parsedUrl
if (pathname === '/a') {
await app.render(req, res, '/a', query)
} else if (pathname === '/b') {
await app.render(req, res, '/b', query)
} else {
await handle(req, res, parsedUrl)
}
} catch (err) {
console.error('Error occurred handling', req.url, err)
res.statusCode = 500
res.end('internal server error')
}
}).listen(port, (err) => {
if (err) throw err
console.log(`> Ready on http://${hostname}:${port}`)
})
})
```
#### Enabling HTTPS on Local Server
Modify the file `server.js`, use [https.createServer([options][, requestListener])](https://nodejs.org/api/https.html#httpscreateserveroptions-requestlistener) to wrap the express service, please check out the sample code below:
```js
// Supprt HTTPS
const fs = require('fs');
const path = require('path');
const https = require('https');
const cert = fs.readFileSync(path.join(__dirname,'../../path/bundle.crt'));
const key = fs.readFileSync(path.join(__dirname,'../../path/ca.key'));
const options = {key: key, cert: cert };
app.prepare().then(() => {
https.createServer(options, async (req, res) => {
try {
...
} catch (err) {
console.error('Error occurred handling', req.url, err)
res.statusCode = 500
res.end('internal server error')
}
}).listen(port, (err) => {
if (err) throw err
console.log(`> Ready on https://${hostname}:${port}`)
})
})
```
access with `https://localhost:3000` or `https://{YOUR_IP}:3000`
### π£ (Step 2) Configure `package.json`
To run the custom server you'll need to update the scripts in package.json like so:
```json
"scripts": {
"dev": "node server.js",
"start": "NODE_ENV=production node server.js"
}
```
**(Optional).** Disabling file-system routing
```js
module.exports = {
useFileSystemPublicRoutes: false,
}
```
### π£ (Step 3) Install PM2 environment
Start Next.js application with PM2 as a service (only works if you are using Node v18.17.0 or above.)
#### 3.1) Installing Node and NPM on hosting server **(Optional).**
Node14+ version will be installed here
```sh
$ curl -sL https://rpm.nodesource.com/setup_14.x | sudo bash -
$ sudo yum install nodejs
$ node --version #v14.16.1
$ npm --version #6.14.12
```
#### 3.2) Installing PM2. With NPM
```sh
$ sudo npm install pm2@latest -g
```
#### 3.3) Frequently used commands for PM2:
```sh
#into your `"fullstack-nextjs-app-template/"` folder directory.
$ cd /{your_directory}/fullstack-nextjs-app-template
#run app
$ pm2 start ecosystem.config.js
#other commands
$ pm2 restart ecosystem.config.js
$ pm2 stop ecosystem.config.js
$ pm2 delete ecosystem.config.js
$ pm2 list
$ pm2 logs
```
#### 3.4) πΉ Now once your build complete successfully run below command to run your Next.js with PM2
```sh
$ pm2 start npm --name "fullstack-nextjs-app-template" -- start
```
destroy process:
```sh
$ pm2 stop "fullstack-nextjs-app-template" & pm2 delete "fullstack-nextjs-app-template"
```
#### 3.5) Detect available init system, generate configuration and enable startup system, and you can check the status of the same using
```sh
$ pm2 startup
$ systemctl status pm2-root
$ pm2 start /{your_directory}/fullstack-nextjs-app-template/ecosystem.config.js --restart-delay=3000
$ pm2 save
```
π‘ Some solutions to problems that may occur when deploying the application with NPM or PM2 on cloud server:
**aοΌThe `build` or `dev` command fails**
When on an M1 Mac and switching from a Node.js version without M1 support to one with, e.g. v14 to v16, you may need a different swc dependency which can require re-installing `node_modules` (npm i --force or yarn install --force).
```sh
$ npm i --force # This can be ignored if you can build
$ rm -rf /{your_directory}/fullstack-nextjs-app-template/.next # Delete the. Next folder
$ npm run build
$ pm2 start ecosystem.config.js
```
*Make sure your server has directory and file permissions to run the project*
**bοΌERROR: permission denied, access '/usr/lib/node_modules'**
*Solution:*
```sh
$ chmod -R a+x node_modules
```
**cοΌERROR: JavaScript heap out of memory**
There is a strict standard limit for memory usage in V8 to be a maximum of ~1GB (32-bit) and ~1.7GB (64-bit), if you do not increase it manually.
*Solution:*
```sh
export NODE_OPTIONS=--max_old_space_size=4096
```
**d) Error: EACCES: permission denied, mkdir '/root/.pm2/xxxx'**
*Solution:*
In general, just avoid using `NPM` to run PM2 commands.
*You could still try the following:*
Make sure you kill any PM2 instance before starting PM2 in no deamon mode (pm2 kill).
```sh
# re-install PM2 (optional)
$ sudo npm i -g pm2
# if pm2 was reinstalled, ts-node must be reinstalled (optional)
$ sudo npm install -g ts-node@latest
# clear all pm2 instances
$ pm2 kill
# then restart it
$ pm2 start xxxxxx
```
#### 3.5) Use domain to access your Next.js appication.
You had created a basic Next.js App from here, then you need to deploy a Next.js App on Apache or Nginx web server. Please refer to the network for the tutorial on setting up the proxy.
### π£ (Step 4) Nginxβs Site Configuration
Now that the app is ready to be deployed, we should prepare the Nginx end. In case Nginx is not installed, it can be easily installed with the apt packaging system by running the following two commands:
```sh
$ sudo apt update
$ sudo apt install nginx
```
or
```sh
$ sudo yum install nginx -y
```
Start Nginx:
```sh
$ systemctl start nginx
```
Start at boot:
```sh
$ systemctl enable nginx
```
Set Up a Firewall Using FirewallD on CentOS 8:
```sh
$ firewall-cmd --permanent --zone=public --add-service=http
$ firewall-cmd --permanent --zone=public --add-service=https
$ firewall-cmd --permanent --zone=public --add-port=3000/tcp
$ firewall-cmd --reload
$ systemctl restart nginx
```
We can check if Nginx is running on the system:
```sh
$ systemctl status nginx
```
Alright, now that the Nginx service has successfully started running, we can go ahead and modify the configuration file found at `/etc/nginx/conf.d/default.conf`. This is where we will point the domain to fire up the correct Next.js application:
```sh
$ vi /etc/nginx/conf.d/default.conf
```
At the end of the file, add:
```bash
server {
listen 443 ssl;
server_name backend1.example.com;
...
location / {
proxy_set_header Host $http_host;
proxy_pass http://{YOUR_IP}:3000;
}
}
```
After adding these lines to the file, we need to restart the Nginx service:
```sh
$ systemctl restart nginx
```
There probably wonβt be any messages if the service restarted successfully. Otherwise, it will spit out lines of error messages.
ππΌ Node.js Port 3000 already in use but it actually isn't?
run the following command
```sh
$ killall -9 node
```
ππΌ Change the Favicon
To change your Site Favicon, navigate the file `pages/_document.tsx` and modify the code between ``
ππΌ Customize Menu
Navigate the file `src/components/Header` and modify it.
ππΌ Set port in next.js
In your package.json file, add -p 8080 to the dev/start scripts to start the server on port 8080:
```json
"scripts": {
"dev": "next -p 8080",
"start": "next start -p 8080"
}
```
Alternatively, if you don't want to hardcode this in the package.json file, you could start the script with ENV variable PORT.
```sh
$ PORT=8080 npm run dev
```
ππΌ Set basePath for a static exported
Locate both `next.config.js` and `scripts/config-rootdir-of-publishing-source.js`.
a) **next.config.js**: Change attributes `basePath` and `assetPrefix`
b) **scripts/config-rootdir-of-publishing-source.js**: Change the paths related to the folder directory in `public/`, such as `assets/`
c) run
```sh
$ npm run action:rootdir
```
ππΌ Site URL (Root Directory) Configurations
Change the root directory of the website so that it can be used when you upload the project to another directory. Modify the key `siteUrl` of the `./src/data/app.json`.
If the file is in the root directory, you can leave it empty. If in another directory, you can write: "/blog". **(no trailing slash)**
```json
{
"siteUrl": "http://localhost:3000",
"copyright": "xxxxxxxxxx"
}
```
ππΌ Deploy Using Docker (build a single next.js program image)
>
> β οΈ Tips: When running the `getServerSideProps` of Next.js, `Express` and `WebSocket` services of Node.js, the communication would be container to container. So for these requests, routes to localhost (`http://localhost:3000`) would not work. Instead it would need to be something like `http://localhost:7777` instead (when communicating from the frontend service to the backend service). The localhost domain would work as expected on the client side requests.
>
> β οΈ Warning: Multiple micro-service containers cannot be opened on the server side at the same time, otherwise the upstream server will terminate the WebSocket connection.
>
>
> When you run this without docker everything works because all services are on localhost. When run via docker-compose they no longer are.
>
### π£ (Step 1) First download docker (version Intel chip, note. macOs10.14 and below versions use up to version 4.11.0)
https://docs.docker.com/desktop/release-notes/#4110
install docker on ubuntu
```sh
$ sudo apt-get update
$ sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
$ sudo docker run hello-world
```
### π£ (Step 2) Create a new file `Dockerfile` in the root directory of the application
```sh
$ cd /Applications/MAMP/htdocs/fullstack-nextjs-app-template
$ touch Dockerfile
$ vi Dockerfile
```
the following:
[Dockerfile](Dockerfile)
β¦
### π£ (Step 3) To add support for Docker to an existing project, simply copy the Dockerfile to the root of the project and add the following to the `next.config.js` file:
You can directly set the `dockerDeploymentEnabled` property to `true` in the current `next.config.js`.
> [!NOTE]
> Use Docker container, don't use [Static Exports](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports).
```js
// next.config.js
module.exports = {
// ... rest of the configuration.
output: 'standalone',
}
```
### π£ (Step 4) Build your container:
Syntax: docker build [OPTIONS] PATH | URL | -
! ! ! Note: The last path is a point, don't miss it
```sh
$ docker build -t fullstack-nextjs-app-template:v1 .
```
[The first deployment takes a few minutes because it needs other docker libraries, and it only takes tens of seconds after that]
> β **If 401 Unauthorized error, first run:**
>
> ```sh
> $ docker pull node:18.20.4-alpine3.20
> ```
>
### π£ (Step 5) Run your application. Based on the tags you gave your Dockerfile, you can now run them with the docker run command.
The -p flag exposes the container's ports to services outside of docker (the first port is the port exposed to the outside). Use of multiple ports: `docker run -p : -p :`
Run your container:
```sh
$ docker run -p 3000:3000 fullstack-nextjs-app-template:v1
```
>
> **NOTE**:
>
> If **Ctrl+C** does not work to terminate the container, please add the following code in the server file such as Express, and use the following command to temporarily run the container. Access [Specify an init process](https://docs.docker.com/engine/reference/run/#specify-an-init-process)
>
> ```js
> // Stop running node in docker with Ctrl+C sends the SIGINT signal.
> // Usage: docker run --init -p :
> const process = require('process');
> process.on('SIGINT', () => {
> console.info("Interrupted")
> process.exit(0);
> });
> ```
>
> ```bash
> $ docker run --init -p :
> ```
>
### π£ (Step 6) Persistence running (exit the command panel is still executed, add a parameter -d)
Run the image with -d to run the container in detached mode, leaving the container running in the background. The -p flag redirects the public port to a private port inside the container.
```sh
$ docker run -p 3000:3000 -d fullstack-nextjs-app-template:v1
```
### π£ (Step 7) Docker process check
```sh
$ docker ps
$ docker stop
$ docker kill
```
### π£ (Step 8) Node.js process check
The process already exists, to delete, for example, port 3000
```sh
#Query the process of port 3000
$ lsof -i tcp:3000
#PID is replaced by the id of the process
$ kill -9
```
### π£ (Step 9) Push image to private server
> Note: change the `192.168.1.140` to yours
#### οΌ1οΌFirst configure the shared folder
Otherwise, an error will be reported:
> docker: Error response from daemon: Mounts denied:Β
#### οΌ2οΌInstall and run [docker-registry](https://docs.docker.com/registry/)
Β
Sometimes it may be inconvenient to use a public repository like Docker Hub, and users can create a local repository for private use. For example, an image built based on a company's internal project.
`docker-registry` is an official tool that can be used to build a private image.
Β
It can be run by obtaining the official **Registry**. By default, the repository will be created in the container's `/var/lib/registry` directory (for Linux or Mac), and now I reset it to a shared directory on my computer.
Β
```bash
docker run --name registry -d Β -p 5000:5000 --restart=always Β -v /Users/changcheng/Desktop/share:/var/lib/registry registry
```
Β
accessοΌhttp://192.168.1.140:5000/v2/
Β
Β
Indicates that port `5000` has been successfully proxied by docker.
Β
Β
#### οΌ3οΌMark the image to point to your registry [IP is replaced with local LAN IP, or other IP]
Β
```bash
$ docker tag fullstack-nextjs-app-template:v1 192.168.1.140:5000/fullstack-nextjs-app-template-v1
```
push it
```bash
$ docker push 192.168.1.140:5000/fullstack-nextjs-app-template-v1
```
Β
#### οΌ4οΌ[Configure the Docker daemon](https://docs.docker.com/registry/recipes/mirror/)
In case of error:
> http: server gave HTTP response to HTTPS client
Please configure `registry-mirrors` image sources and `insecure-registries` private repositories in Docker Desktop
Β
Modify `daemon.json` (can be modified directly through the Docker Desktop)
```bash
$ cat ~/.docker/daemon.json
```
Add the following configuration:
```json
{
Β Β Β Β "registry-mirror":[
Β Β Β Β Β Β Β Β "http://hub-mirror.c.163.com"
Β Β Β Β ],
Β Β Β Β "insecure-registries":[
Β Β Β Β Β Β Β Β "192.168.1.140:5000"
Β Β Β Β ]
}
```
Β
restart docker
#### οΌ5οΌPull the image [LAN can also use it]
```bash
$ docker pull 192.168.1.140:5000/fullstack-nextjs-app-template-v1
```
### π£ (Step 10) Export the image (Optional)
View the container that is running in the background (note that you need to run it first to find the id)
```sh
$ docker ps
```
To package the running docker container into an image image, run `docker commit `
```sh
$ docker commit 16cb27979742 fullstack-nextjs-app-template:v1
```
Next, save the newly packaged image as a tar file, run `docker save -o `
```sh
$ docker save fullstack-nextjs-app-template:v1 -o ./fullstack-nextjs-app-template-v1.tar
```
### π£ (Step 11) Package into an application for the arm64 architecture (Optional)
To package a Next.js app using Docker for ARM architecture, follow these steps:
#### οΌ1οΌ`Dockerfile`
```sh
...
# A base image for the ARM architecture, such as the arm64 version of Node.js
FROM node:18.20.4-alpine3.20 AS base
...
```
#### οΌ2οΌbuild command
```sh
$ docker build --platform linux/arm64 -t fullstack-nextjs-app-template-arm64:v1 .
```
Cross-platform:
```sh
$ docker buildx create --use
$ docker buildx build --platform linux/arm64 -t fullstack-nextjs-app-template-arm64:v1 .
```
> **Notes**
> - Docker Buildx enables multi-platform builds. Ensure that Docker is set up to use Buildx by running `docker buildx create --use`.
> - Using the `alpine` version of the Node.js base image helps keep the image size small and reduces dependencies, which is beneficial for ARM devices.
> - If you're using packages that include native modules (such as `sharp`), make sure they are correctly compiled or installed for the ARM architecture.
ππΌ Deploy Using Docker (Build composite image that include other custom images)
### π£ (Step 1) Create a file `docker-compose.yml`, the content as follows:
```yml
services:
web:
build: .
ports:
- "3000:3000"
depends_on:
- my_node_service
my_node_service:
image: "my-node-server:v1"
ports:
- "4001:4001"
```
### π£ (Step 2) Build another image, like this:
```bash
# build
$ docker build -t my-node-server:v1 .
# test
$ docker run --init -p 4001:4001 my-node-server:v1
```
### π£ (Step 3) Build a composite image, run:
```bash
$ docker-compose up
```
ππΌ Deploy Using Docker (Common Load-balancing Solutions of Socket.io Issue)
#### 1. Multiple Kubernetes pods
**Solution 1:**
Using k8s with load balancing, without nginx. Config the sessionAffinity on service:
```yml
service.spec.sessionAffinity = "ClientIP"
```
**Solution 2:**
Adding transports: ['websocket'] to socketIOClient options in our multi-pod Kubernetes environment:
```yml
socketIOClient(someUrl, {transports: ['websocket']});
```
#### 2. Other platforms
Refer to: [Using multiple nodes](https://socket.io/docs/v4/using-multiple-nodes/)
ππΌ Installation Error or Unable To Run
a) Has `node_modules` folder, just do it directly.
If running `npm run ` fails because Node has been upgraded, use `npx -p node@<version> <your_script>` to run:
such as
```sh
$ npx -p [email protected] npm run dev
$ npx -p [email protected] npm run start
```
b) If there is no `node_modules` folder, using `npm install --legacy-peer-deps` is still unsuccessful. After deleting the dependencies of **package.json** and remove file **package-lock.json**, use the following command to reinstall:
```sh
$ npm install <package1> <package2> --legacy-peer-deps
$ npm install --save-dev <package1> <package2> --legacy-peer-deps
```
c) NPM or NPX cache error
View the location of the local npm cache:
```sh
$ npm config get cache
```
Clear cache (npm and npx)
```sh
$ npm cache clean --force
```
or
```sh
$ rm -rf ~/.npm
```
Check cache
```sh
$ npm cache verify
```
</details>
## Contributing
- [React](https://reactjs.org/)
- [nextjs](https://nextjs.org/)
- [redux](https://redux.js.org/)
- [axios](https://github.com/axios/axios)
- [Express](http://expressjs.com/)
- [php-express](https://github.com/fnobi/php-express)
- [next-cookies](https://github.com/matthewmueller/next-cookies)
- [pm2](https://pm2.keymetrics.io/)
## Supported development environment
- Next.js 13.0.0 to 14+
- React 18 +
- TypeScript 4.x.x +
- Express 4.x.x
## Changelog
[releases](CHANGELOG.md)
## Licensing
Licensed under the [MIT](https://opensource.org/licenses/MIT).