99 | )
100 | }
101 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Next.js + Fleek Starter Kit
2 |
3 | 
4 |
5 | ## 🚀 Project Structure
6 |
7 | Inside of your Next.js project, you'll see the following folders and files:
8 |
9 | ```
10 | /
11 | ├── public/
12 | │ └── favicon.svg
13 | ├── src/
14 | │ └── app/
15 | │ ├── favicon.ico
16 | │ ├── globals.css
17 | │ ├── layout.tsx
18 | │ └── page.tsx
19 | ├── next.config.js
20 | ├── tailwind.config.js
21 | ├── tsconfig.json
22 | └── package.json
23 | ```
24 |
25 | If you want to lern more about the `app` router you can checkout [Next.js documentation](https://nextjs.org/docs/app/building-your-application/routing#the-app-directory).
26 |
27 | Any static assets, like images, can be placed in the `public/` directory.
28 |
29 |
30 | ## 🧞 Commands
31 |
32 | All commands are run from the root of the project, from a terminal:
33 |
34 | | Command | Action |
35 | | :--------------------- | :----------------------------------------------- |
36 | | `pnpm install` | Installs dependencies |
37 | | `pnpm run dev` | Starts local dev server at `localhost:3000` |
38 | | `pnpm run build` | Build your production site to `./out/` |
39 | | `pnpm run start` | Preview your build locally, before deploying |
40 | | `pnpm run lint ...` | Run Linter |
41 |
42 | ## ⚡ How to deploy to Fleek
43 |
44 | ### 1. Create a `fleek.json` config file:
45 | You can configure this site deployment using [Fleek CLI]() and running:
46 | ```
47 | > fleek sites init
48 | WARN! Fleek CLI is in beta phase, use it under your own responsibility
49 | ? Choose one of the existing sites or create a new one. ›
50 | ❯ Create a new site
51 | ```
52 | It will prompt you for a `name`, `dist` directory location & `build command`
53 | - `name`: How you want to name the site
54 | - `dist`: The output directory where the site is located, for this template it's `out`
55 | - `build command`: Command to build your site, this will be used to deploy the latest version either by CLI or Github Actions
56 |
57 | ### 2. Deploy the site
58 | After configuiring your `fleek.json` file, you can deployt the site by running
59 |
60 | ```
61 | fleek sites deploy
62 | ```
63 | After running it you will get an output like this:
64 | ```
65 | WARN! Fleek CLI is in beta, use it at your own discretion
66 | > Success! Deployed!
67 | > Site IPFS CID: QmP1nDyoHqSrRabwUSrxRV3DJqiKH7b9t1tpLcr1NTkm1M
68 |
69 | > You can visit through the gateway:
70 | > https://ipfs.io/ipfs/QmP1nDyoHqSrRabwUSrxRV3DJqiKH7b9t1tpLcr1NTkm1M
71 | ```
72 |
73 | ### Extra features
74 | - **Continuous Integration (CI):** `fleek sites ci` [Documentation.](https://docs.fleek.xyz/services/sites/#continuous-integration-ci)
75 | - **Adding custom domains:** `fleek domains create` [Documentation.](https://docs.fleek.xyz/services/domains/)
76 |
77 |
78 | ### Keep in mind:
79 |
80 | This template has been configured to produce a static output.
81 |
82 | ```js
83 | /** @type {import('next').NextConfig} */
84 | const nextConfig = {
85 | output: 'export',
86 | reactStrictMode: true,
87 | images: {
88 | unoptimized: true,
89 | },
90 | trailingSlash: true,
91 | }
92 |
93 | module.exports = nextConfig
94 |
95 | ```
96 |
97 | You can find more information about static builds in [Next Documentation](https://nextjs.org/docs/app/building-your-application/deploying/static-exports#configuration)
98 |
99 |
100 | ## 👀 Want to learn more?
101 |
102 | Feel free to check [Next.js documentation](https://nextjs.org/docs) or jump into Next.js [learning platform](https://nextjs.org/learn/foundations/about-nextjs?utm_source=next-site&utm_medium=nav-cta&utm_campaign=next-website).
103 |
104 |
--------------------------------------------------------------------------------