Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 2.65 KB

README.md

File metadata and controls

78 lines (53 loc) · 2.65 KB

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.js. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.


Project Structure:

  • /app/ - The Next.js app that have respective pages in respective folder(NextJs has folder based routing, pathname in url will be the folder name and accordingly the page will be rendered)
    • /app/api/ - The Next.js API routes/backend
    • /app/folder/ - Folder based routing, pages for respective routes(folder names)
  • /components/ - The reusable UI components with some logic
  • '/models/` - Schema models for database
  • /public/ - The Next.js public directory
  • /styles/ - The Next.js styles directory
  • /utils/ - Just some utility functions like connectToDB to call to connect to the MongoDB database

Environment Variables:

  • Create .env in the root with following variables:
GOOGLE_ID=
GOOGLE_CLIENT_SECRET=
MONGODB_URI=
NEXTAUTH_URL=
NEXTAUTH_URL_INTERNAL=
NEXTAUTH_SECRET=

Packages used:

  • next - The Next.js framework
  • next-auth - The Next.js authentication library
  • mongodb - The MongoDB driver
  • mongoose - The MongoDB ODM
  • react - The React.js framework
  • react-dom - The React.js DOM renderer
  • tailwindcss - For styling

Deployed on Vercel