This is a single page app built with Next.js using the pages router and Mantine.
This app comes with the following features:
- PostCSS with mantine-postcss-preset
- TypeScript
- Storybook
- Jest setup with React Testing Library
- ESLint setup with eslint-config-mantine
- README.md: This file, providing an overview and documentation for the project.
- LICENCE: The license under which the project is distributed.
- package.json: Contains project metadata and dependencies.
- tsconfig.json: TypeScript configuration file.
- next.config.js: Next.js configuration file.
- postcss.config.cjs: Configuration for PostCSS.
- jest.config.cjs: Configuration for Jest.
- jest.setup.cjs: Setup file for Jest.
- yarn.lock: Lockfile for Yarn package manager.
-
components/: Contains React components used throughout the application.
- Layout/: Contains layout components, such as
Layout.tsx
.
- Layout/: Contains layout components, such as
-
pages/: Contains Next.js pages.
- _app.tsx: Custom App component to initialize pages.
- _document.tsx: Custom Document component for SSR.
- index.tsx: A specific page for James Day.
-
public/: Static assets like images, icons, etc.
- favicon.svg: The favicon for the application.
-
test-utils/: Utilities for testing.
- index.ts: Entry point for test utilities.
- render.tsx: Custom render function for testing.
-
.idea/: Configuration files for JetBrains IDEs.
dev
– start the development serverdeploy
- build and deploy to awsbuild
– bundle the application for productionexport
– export the static website to theout
folderanalyze
– analyze the application bundle with @next/bundle-analyzer
typecheck
– check TypeScript typeslint
– run ESLintprettier:check
– check files with Prettierjest
– run Jest testsjest:watch
– start Jest in watch modetest
– runjest
,prettier:check
,lint
, andtypecheck
scripts
storybook
– start the Storybook development serverstorybook:build
– build the production Storybook bundle tostorybook-static
prettier:write
– format all files with Prettier
If you would like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bugfix:
git checkout -b feature-name
- Make your changes.
- Commit your changes:
git commit -m "Description of your changes"
- Push to your branch:
git push origin feature-name
- Create a Pull Request.
We appreciate your contributions!
This project is licensed under the MIT License. See the LICENSE file for details.
dev
– start the development serverdeploy
- build and deploy to awsbuild
– bundle the application for productionexport
– export the static website to theout
folderanalyze
– analyze the application bundle with @next/bundle-analyzertypecheck
– check TypeScript typeslint
– run ESLintprettier:check
– check files with Prettierjest
– run Jest testsjest:watch
– start Jest in watch modetest
– runjest
,prettier:check
,lint
, andtypecheck
scriptsstorybook
– start the Storybook development serverstorybook:build
– build the production Storybook bundle tostorybook-static
prettier:write
– format all files with Prettier
To get started with the project, follow these steps:
-
Clone the repository:
git clone https://github.com/tdobson/james.tdobson.net.git cd james.tdobson.net
-
Install dependencies:
yarn install
-
Run the development server:
yarn dev
-
Open your browser and navigate to
http://localhost:3000
to see the application running.
If you would like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bugfix:
git checkout -b feature-name
- Make your changes.
- Commit your changes:
git commit -m "Description of your changes"
- Push to your branch:
git push origin feature-name
- Create a Pull Request.
We appreciate your contributions!
This project is licensed under the MIT License. See the LICENSE file for details.