|
1 | | -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). |
| 1 | +# Next Landing |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +This is a landing page project built with Next.js, designed to provide small |
| 4 | +businesses with a clean and professional online presence. The landing page is |
| 5 | +easily customizable and can be configured using YAML files, making it simple to |
| 6 | +update and maintain. |
4 | 7 |
|
5 | | -First, run the development server: |
| 8 | +Next.js is a powerful framework that offers many advantages, including easy |
| 9 | +setup, optimized performance, built-in SEO support, and high customizability |
| 10 | +and extensibility. Additionally, the landing page uses static site generation, |
| 11 | +resulting in faster load times, improved SEO, and reduced server load. |
| 12 | + |
| 13 | +We believe this landing page project will be a valuable asset for small |
| 14 | +businesses seeking to establish an online presence. |
| 15 | + |
| 16 | + |
| 17 | +## Project Setup |
| 18 | + |
| 19 | +1. Clone the repository. |
| 20 | +2. Install dependencies by running `npm install`. |
| 21 | +3. Configure the title and metatags of the website using the |
| 22 | + `/config/config.yaml` file. |
| 23 | +4. Configure the menu with the `/config/menu.yaml` file. |
| 24 | +5. Configure the content of the sections of the landing page by editing the |
| 25 | + YAML files inside the `/data` directory. |
| 26 | + |
| 27 | + |
| 28 | +## Running Locally |
| 29 | + |
| 30 | +To run the development version of the landing page locally, use the following |
| 31 | +command: |
6 | 32 |
|
7 | 33 | ```bash |
8 | 34 | npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | 35 | ``` |
14 | 36 |
|
15 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
16 | | - |
17 | | -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. |
18 | | - |
19 | | -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. |
| 37 | +This will start the development server at `http://localhost:3000/`. |
20 | 38 |
|
21 | | -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. |
| 39 | +To run the production version of the landing page locally, use the following |
| 40 | +commands: |
22 | 41 |
|
23 | | -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. |
| 42 | +```bash |
| 43 | +npm run build |
| 44 | +npm run start |
| 45 | +``` |
24 | 46 |
|
25 | | -## Learn More |
| 47 | +This will build the production version of the landing page and start the server |
| 48 | +at `http://localhost:3000/`. |
26 | 49 |
|
27 | | -To learn more about Next.js, take a look at the following resources: |
28 | 50 |
|
29 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
30 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 51 | +## Deploying to Vercel |
31 | 52 |
|
32 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! |
| 53 | +To deploy the landing page to Vercel, follow these steps: |
33 | 54 |
|
34 | | -## Deploy on Vercel |
| 55 | +1. Create an account on Vercel. |
| 56 | +2. Install the Vercel CLI by running `npm install -g vercel`. |
| 57 | +3. Run `vercel login` and follow the prompts to authenticate your account. |
| 58 | +4. Run `vercel` to deploy the project to Vercel. |
| 59 | +5. Follow the prompts to configure your deployment settings. |
35 | 60 |
|
36 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 61 | +Once the deployment is complete, your landing page will be live at the URL |
| 62 | +provided by Vercel. |
37 | 63 |
|
38 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |
| 64 | +Thank you for choosing this landing page project! |
0 commit comments