|
| 1 | +# Next-Bootstrap.ts |
| 2 | + |
| 3 | +[React][1] project scaffold based on [TypeScript][2], [Next.js][3] & [Bootstrap][4]. And this project bootstrapped with [`create-next-app`][5]. |
| 4 | + |
| 5 | +[][6] |
| 6 | +[][7] |
| 7 | + |
| 8 | +## Technology stack |
| 9 | + |
| 10 | +- Language: [TypeScript v4][2] |
| 11 | +- Component engine: [Nextjs v12][3] |
| 12 | +- Component suite: [Bootstrap v5][4] |
| 13 | +- Test framework: [Jest][8] + [Playwright][9] |
| 14 | +- CI / CD: GitHub [Actions][10] + [Vercel][11] |
| 15 | + |
| 16 | +## Getting Started |
| 17 | + |
| 18 | +First, run the development server: |
| 19 | + |
| 20 | +```bash |
| 21 | +npm run dev |
| 22 | +# or |
| 23 | +yarn dev |
| 24 | +``` |
| 25 | + |
| 26 | +Open http://localhost:3000 with your browser to see the result. |
| 27 | + |
| 28 | +You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. |
| 29 | + |
| 30 | +[API routes][12] can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in `pages/api/hello.ts`. |
| 31 | + |
| 32 | +The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes][12] instead of React pages. |
| 33 | + |
| 34 | +## Learn More |
| 35 | + |
| 36 | +To learn more about Next.js, take a look at the following resources: |
| 37 | + |
| 38 | +- [Next.js Documentation][13] - learn about Next.js features and API. |
| 39 | +- [Learn Next.js][14] - an interactive Next.js tutorial. |
| 40 | + |
| 41 | +You can check out [the Next.js GitHub repository][15] - your feedback and contributions are welcome! |
| 42 | + |
| 43 | +## Deploy on Vercel |
| 44 | + |
| 45 | +The easiest way to deploy your Next.js app is to use the [Vercel Platform][11] from the creators of Next.js. |
| 46 | + |
| 47 | +Check out our [Next.js deployment documentation][16] for more details. |
| 48 | + |
| 49 | +## End-to-End testing |
| 50 | + |
| 51 | +### NPM script |
| 52 | + |
| 53 | +```shell |
| 54 | +npm run e2e |
| 55 | +``` |
| 56 | + |
| 57 | +### VS Code |
| 58 | + |
| 59 | +press <key>F5</key> |
| 60 | + |
| 61 | +### Learn more |
| 62 | + |
| 63 | +1. Runner & Assert framework: [Jest][8] |
| 64 | +2. Browser Operation library: [Playwright][9] & [its community][17] |
| 65 | + |
| 66 | +[1]: https://reactjs.org/ |
| 67 | +[2]: https://www.typescriptlang.org/ |
| 68 | +[3]: https://nextjs.org/ |
| 69 | +[4]: https://getbootstrap.com/ |
| 70 | +[5]: https://github.com/vercel/next.js/tree/canary/packages/create-next-app |
| 71 | +[6]: https://david-dm.org/idea2app/next-bootstrap-ts |
| 72 | +[7]: https://github.com/idea2app/next-bootstrap-ts/actions |
| 73 | +[8]: https://jestjs.io/ |
| 74 | +[9]: https://playwright.dev/ |
| 75 | +[10]: https://github.com/features/actions |
| 76 | +[11]: https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme |
| 77 | +[12]: https://nextjs.org/docs/api-routes/introduction |
| 78 | +[13]: https://nextjs.org/docs |
| 79 | +[14]: https://nextjs.org/learn |
| 80 | +[15]: https://github.com/vercel/next.js/ |
| 81 | +[16]: https://nextjs.org/docs/deployment |
| 82 | +[17]: https://playwright.tech/ |
0 commit comments