https://github.com/austin-raey/before.tmp

https://github.com/austin-raey/before.tmp

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/austin-raey/before.tmp
• Owner: austin-raey
• Created: 2024-12-05T01:40:09.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-18T15:29:22.000Z (about 1 month ago)
• Last Synced: 2024-12-18T16:31:24.322Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 337 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Before.tmp

> [!CAUTION]

> 🚧 This project is currently under construction. Docs need to be finished, batteries added, and a few other enterprise-ready conveniences need to still be plugged in. 🚧

Quick Links: [Getting Started](#getting-started), [Opinionated Choices](#opinionated-choices)

**Before.tmp** is an opinionated NEXT.js open-source starter template with the following principles in mind:

- **🗜️ Minimal**: The only installed dependencies are the ones actually used. No extra bloat. You can build from here.

- **💎 Production Ready**: Project configuration and dependencies have been chosen for their ubiquitous use across the development community. Sensible defaults should be chosen to ensure production builds remain perfomant. Safeguards are in place to ensure code quality and testing standards are met before production.

- **💻 Developer Friendly**: Easy to poke around and customize settings as necessary, easy package upgrades. IDE formatting should work as expected. No configuartion rot. Dependency choices have a large online community, ensuring you can find help and resources easily.

## Getting Started

Simply clone this repository and install the dependencies with your preferred package manager:

```shell

# Clone the repository

git clone https://github.com/austin-raey/before.tmp

cd ./before.tmp

rm -rf ./.git

rm ./README.md

git init

# Install dependencies with your preferred package manager

npm install

pnpm install

yarn install

bun install

```

## Opinionated Choices

Before.tmp has a few configuration and package choices I would encourage you to consider/keep. If there is anything you do not like, it should be straightforward to remove or re-configure with minimal effort.

In no particular order (and by no means exhaustive), here are some of those made for this template:

- **[Tailwind](https://tailwindcss.com/)**: An excellent utility-first CSS framework that outputs minimal CSS. Easy to scaffold out a design quickly and add more advanced styles as needed.

- **[ESLint](https://eslint.org/) + [Prettier](https://prettier.io/)** _(formatting, code quality)_: A powerful combination to ensure consistent code quality and formatting between developers. To call out a few notable plugins:

  - [`eslint-plugin-perfectionist`](https://perfectionist.dev/) _(sorting, formatting)_: Ensures predictable ordering of properties, imports, etc.

  - [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn) _(formatting, code quality)_: Enforces some useful practices and coding standards.

  - Also included are some 1st party ESLint rules I would consider essential for any Next.js project. These typically enforce best practices, code quality, and formatting.

    [`@eslint/js`](https://eslint.org/), [`typescript-eslint`](https://typescript-eslint.io/), [`eslint-plugin-react-compiler`](https://react.dev/learn/react-compiler), [`eslint-config-next`](https://nextjs.org/docs/app/api-reference/config/eslint), [`@next/eslint-plugin-next`](https://nextjs.org/docs/app/api-reference/config/eslint)

- **Package Versioning**: `.npmrc` has been configured with `save-exact=true`. This ensures consistent package versions for developers and deployment. Even minor version bumps can introduce breaking changes sometimes, so this is included to keep surprises to a minimum.