Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guptabhaskar/nextjs-boilerplate
Boilerplate and Starter for Next JS 13+, Tailwind CSS 3.2.4 and TypeScript
https://github.com/guptabhaskar/nextjs-boilerplate
eslint eslint-config husky nextjs nextjs-boilerplate nextjs-starter postcss postgresql prettier sequelize sequelize-orm tailwindcss typescript
Last synced: 6 days ago
JSON representation
Boilerplate and Starter for Next JS 13+, Tailwind CSS 3.2.4 and TypeScript
- Host: GitHub
- URL: https://github.com/guptabhaskar/nextjs-boilerplate
- Owner: guptabhaskar
- Created: 2023-02-16T15:16:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-16T15:20:47.000Z (almost 2 years ago)
- Last Synced: 2024-09-26T02:01:31.747Z (4 months ago)
- Topics: eslint, eslint-config, husky, nextjs, nextjs-boilerplate, nextjs-starter, postcss, postgresql, prettier, sequelize, sequelize-orm, tailwindcss, typescript
- Language: JavaScript
- Homepage:
- Size: 96.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-nextjs-boilerplates - guptabhaskar/nextjs-boilerplate
- awesome-nextjs-boilerplates - guptabhaskar/nextjs-boilerplate
README
# Boilerplate and Starter for Next JS 13+, Tailwind CSS 3.2.4 and TypeScript
๐ Boilerplate and Starter for Next.js, Tailwind CSS and TypeScript
โก๏ธ Made with developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, PostCSS, Tailwind CSS, Sequelize.
Clone this project and use it to create your own [Next.js](https://nextjs.org) project.
### Features
Includes:
- โก๏ธ [Next.js](https://nextjs.org) for Static Site Generator
- ๐ Type checking [TypeScript](https://www.typescriptlang.org)
- ๐จ Integrate with [Tailwind CSS](https://tailwindcss.com)
- ๐จ Strict Mode for TypeScript and React 18
- โ Linter with [ESLint](https://eslint.org) (default NextJS Core Web Vitals)
- ๐งน Code Formatter with [Prettier](https://prettier.io)
- ๐ถ Husky for Git Hooks
- ๐พ Sequelize as an ORM for connecting to PostgreSQL, MySQL, MariaDB, SQLite databases, and more### Getting started
Run the following command on your local environment:
```shell
git clone https://github.com/guptabhaskar/nextjs-boilerplate
cd nextjs-boilerplate
npm install
cp .env.local.example .env
```Open `.env` and add the `DATABASE_URL`(which should be a link to PostgreSQL DB), you can change it to any database(like MySQL, MariaDB, SQLite databases, and more) of your choice in `server/config/database.js`.
Commands to seed the database(Database seeding):
```shell
node_modules/.bin/sequelize db:migrate
node_modules/.bin/sequelize db:seed:all
```This will seed the database with objects in `server/seeders`.
Then, you can run locally in development mode with live reload:
```shell
npm run dev
```Open http://localhost:3000 with your favorite browser to see your project.
Go to http://localhost:3000/api/profiles to see the data in the profiles table.