Skip to content

Commit

Permalink
Adds template project
Browse files Browse the repository at this point in the history
  • Loading branch information
wdevon99 committed Mar 2, 2024
1 parent c7e8966 commit ee67be5
Show file tree
Hide file tree
Showing 48 changed files with 6,895 additions and 2 deletions.
10 changes: 10 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
NEXTAUTH_URL=
NEXTAUTH_SECRET=

GOOGLE_ID=
GOOGLE_CLIENT_SECRET=

GITHUB_ID=
GITHUB_CLIENT_SECRET=

MONGODB_URI=
3 changes: 3 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "next/core-web-vitals"
}
37 changes: 37 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
.env
20 changes: 20 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"typescript.preferences.importModuleSpecifier": "non-relative",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": [
"source.fixAll.eslint"
],
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact"
],
"files.associations": {
"*.js": "javascript",
"*.jsx": "javascriptreact",
"*.ts": "typescript",
"*.tsx": "typescriptreact"
},
"editor.tabSize": 2,
}
67 changes: 65 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,65 @@
# next-js-starter
Full-stack starter template 2024
# Next.js Full-stack starter template 2024

Welcome to the Next.js Full-stack starter template! This template provides a starting point for creating full-stack applications with Next.js.

![Next.js](https://img.shields.io/badge/next.js-242424?style=for-the-badge&logo=nextdotjs&logoColor=white)
![Next-Auth](https://img.shields.io/badge/Next%20Auth-563D7C?style=for-the-badge&logoColor=white)
![Typescript](https://img.shields.io/badge/Typescript-007acc?style=for-the-badge&logo=typescript&logoColor=fff)
![React](https://img.shields.io/badge/-React-61DBFB?style=for-the-badge&logo=react&logoColor=black)
![Ant-Design](https://img.shields.io/badge/AntDesign-0170FE?style=for-the-badge&logo=antdesign&logoColor=white)
![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white)
![HTML](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white)
![SASS Badge](https://img.shields.io/badge/Sass-CC6699?style=for-the-badge&logo=sass&logoColor=white)

## Features ⚡

- **NextAuth:** Integration of NextAuth for authentication, providing support for various authentication providers.
- **TypeScript:** Developed with TypeScript for type safety and improved developer experience.
- **MongoDB:** Integration with MongoDB for database management and storage.
- **Ant Design:** Includes Ant Design for UI components, providing a sleek and modern design out of the box.
- **Styling:** Add your preferred styling solution, whether it's CSS, SCSS, or CSS-in-JS.

![Screenshot](https://img.hotimg.com/ss0801c6061e6c5b5d.png)

---

## How to use this template? 🤔

To get started with this template, you just need to follow these simple steps:

1. Clone the repository:

```
git clone https://github.com/wdevon99/Next-js-starter.git
```

2. Install dependencies:

```
npm i
```

3. Add `.env` file and add the values for the following keys:

```
NEXTAUTH_URL=
NEXTAUTH_SECRET=
GOOGLE_ID=
GOOGLE_CLIENT_SECRET=
GITHUB_ID=
GITHUB_CLIENT_SECRET=
MONGODB_URI=
```

4. Run project locally

```
npm run dev
```

---

## Adding a new auth provider 🔒
4 changes: 4 additions & 0 deletions next.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/** @type {import('next').NextConfig} */
const nextConfig = {};

export default nextConfig;
Loading

0 comments on commit ee67be5

Please sign in to comment.