next-start

(β˜… 255)

A basic Next.js starter.

  • .env.example
  • .eslintrc.json
  • .gitignore
  • .npmrc
  • .prettierignore
  • .prettierrc.json
  • docker-compose.yml
  • drizzle.config.ts
  • LICENSE
  • next.config.mjs
  • package.json
  • pnpm-lock.yaml
  • postcss.config.mjs
  • README.md
  • tailwind.config.ts
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/w3cj/next-start

Downloads the entire project code from GitHub to your computer.

cd next-start

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm install

Downloads and installs the libraries listed in package.json.

pnpm run db:migrate

Type this command into your terminal and run it.

pnpm run dev

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation