@tmcb/next.tmcb.space

A Next.js Personal Website with a Native Authoring Experience

This starter is based on @sanity-io/template-nextjs-personal-website

Prerequisites

In order to run the project we need the following software binaries installed on our development machines:

• node>=21.1.0
• npm>=10.2.3

We can also use one of the listed cloud providers we support:

🖥️ Local development

To install the application:

npm ci

To start a local copy of the app on port 3000:

npm run dev

📦 Docker builds

A development preview can also be run from docker:

docker build -t next.tmcb.space .
docker run -p 8080:80 next.tmcb.space

Alternatively you can pull the production container and skip all builds:

docker run -dit -p 8080:80 ghcr.io/tmcb-space/next.tmcb.space:latest

🎨 Code linting

To check the code and styles quality, use the following command:

npm run lint

This will also display during development, but not break on errors.

To fix the linting errors, use the following command:

npm run format

It is advised to run this command before committing or opening a pull request.

📕 Types

We have a couple of scripts to check and adjust missing types.

In order to dry run what types would be added to package.json:

npm run types:auto-check

In order to add any missing types to package.json:

npm run types:auto-add

🚀 Production deployment

A production deployment is a complete build of the project, including the build of the static assets.

npm run build

🤝 Contributing

We have a commit utility called @tmcb/conventional-commit that helps you write your commits in a way that is easy to understand and process by others.

It is generally integrated as an npm script but you can run it with npx as well:

npm run push

For any other npm based project or dotnpmrc defaulting to --yes:

npx -y @tmcb/conventional-commit

⚖️ LICENSE

MIT © TED (Teodor-Eugen Dutulescu) Vortex