|
1 | | -## Getting Started |
| 1 | +## Next.js & Lingui: Building a Multi-Lingual Website |
2 | 2 |
|
3 | | -First, run the development server: |
| 3 | +[](https://github.com/nekofar/nextjs-lingui-starter/releases) |
| 4 | +[](https://github.com/nekofar/nextjs-lingui-starter/actions/workflows/build.yml) |
| 5 | +[](https://github.com/nekofar/nextjs-lingui-starter/blob/master/LICENSE) |
| 6 | +[](https://twitter.com/nekofar) |
| 7 | +[](https://ud.me/nekofar.crypto) |
4 | 8 |
|
5 | | -```bash |
6 | | -pnpm dev |
7 | | -``` |
8 | 9 |
|
9 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 10 | +### Overview |
10 | 11 |
|
11 | | -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. |
| 12 | +Welcome to the Next.js & Lingui starter project! This repository demonstrates the seamless integration of Next.js, a |
| 13 | +powerful React framework for building server-side rendered applications, with Lingui, the ultimate solution for |
| 14 | +multi-lingual support in web projects. |
12 | 15 |
|
13 | | -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. |
| 16 | +Our goal is to showcase the process of creating a multi-lingual website that caters to a diverse global audience. With |
| 17 | +Next.js providing performance and SEO advantages, and Lingui simplifying translation management, this demo project |
| 18 | +highlights the best practices for internationalization and localization. |
14 | 19 |
|
15 | | -## Learn More |
| 20 | +### Key Features |
16 | 21 |
|
17 | | -To learn more about Next.js, take a look at the following resources: |
| 22 | +* **Next.js Benefits**: Experience the advantages of using Next.js for server-side rendering, static site generation, and |
| 23 | + client-side routing. Learn how it enhances performance, SEO, and simplifies development. |
| 24 | +* **Lingui's Power**: Explore Lingui's capabilities in handling translations, message extraction, language pluralization, |
| 25 | + and locale-specific formatting. |
| 26 | +* **Dynamic Language Switching**: Witness real-time language switching, enabling users to seamlessly toggle between |
| 27 | + different languages without losing their place on the site. |
18 | 28 |
|
19 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
20 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 29 | +### Getting Started |
21 | 30 |
|
22 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! |
| 31 | +Click on `Use this template` to create the repo for your app. |
| 32 | + |
| 33 | +Then, to use this project template, follow these steps: |
| 34 | + |
| 35 | +1. Clone this repository: `git clone https://github.com/your-username/your-repo.git` |
| 36 | +2. Navigate to the project directory: `cd your-repo` |
| 37 | +3. Install project dependencies: `pnpm install` |
| 38 | +4. Start the development server: `pnpm run dev` |
| 39 | +5. Open your browser and visit http://localhost:3000 to see the application in action. |
| 40 | + |
| 41 | +### Contributing |
| 42 | + |
| 43 | +We welcome contributions to this project! To contribute, follow these steps: |
| 44 | + |
| 45 | +1. Fork the repository |
| 46 | +2. Create a new branch: `git checkout -b your-feature` |
| 47 | +3. Make your changes and commit them: `git commit -m "Add your feature"` |
| 48 | +4. Push to the branch: `git push origin your-feature` |
| 49 | +5. Open a pull request to the main branch of this repository |
| 50 | + |
| 51 | +### License |
| 52 | + |
| 53 | +This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details. |
0 commit comments