Skip to content

WarwickAI/website

Repository files navigation

Website

Planning to use Next.js with Tailwind CSS and TypeScript.

Getting Started

Requires Node.js 20.

Created using:

  1. npx create-next-app@latest website --typescript (Next.js with TypeScript)
  2. cd website
  3. npm install -D tailwindcss postcss autoprefixer (Tailwind CSS)
  4. npx tailwindcss init -p (Tailwind CSS)

Code formatting:

  1. npm install -D prettier prettier-plugin-tailwindcss (Installing Prettier)
  2. npx prettier ./src --write --plugin=prettier-plugin-tailwindcss (Running Prettier)

Recommended VS Code extensions:

  1. Tailwind CSS IntelliSense
  2. Prettier - Code formatter
  3. PostCSS Language Support

Running Locally

To run locally with hot reloading:

  1. npm run dev

To test a build (as would be built by Vercel):

  1. npm run build

Deploying

Main website is the Main branch of GitHub. Make a pull request to it for the automatic deployment pipeline to kick in.

  • Have another branch, push to it, then make a pull request on GitHub to main.
    • This will require a reviewer (can be bypassed for small patches + hotfixes)