Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eric-prog committed Aug 7, 2023
1 parent 7fd5889 commit 8c9fb7f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 19 deletions.
32 changes: 13 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,26 @@
# Next.js Hackathon Template

<img src="./readme-assets/authhacks.png" />

### [Template Features](#-the-hackathon-template-comes-with-the-following-full-stack-features) 🪐 | [Tech Stack](#-made-with) ✨ | [Deploy](#-deploy) 🚀 | [Setup](#-setup-local-testing) ⚙️ | [Descope](#-descope) 🔑 | [Template Data](#-template-data) 👾 | [Airtable Setup](#-airtable-setup) 📦 | [Gallery](#-gallery) 👨‍🍳
### [Template Features](#-the-hackathon-template-comes-with-the-following-full-stack-features) · [Tech Stack](#-made-with) · [Setup](#-setup-local-testing) · [Descope](#-descope) · [Template Data](#-template-data) · [Airtable Setup](#-airtable-setup) · [Deploy](#-deploy) · [Gallery](#-gallery)

<br />

> **_NOTE:_** THIS IS USING NEXT.JS 12. FOR THE LATEST NEXT.JS 13 SEE THE MOST UP-TO-DATE [REPO](https://github.com/descope/nextjs-hackathon-template/).
## 🚀 The Next.js Hackathon Template comes with Next.js 12 and Authentication using NextAuth and Descope.

## 🪐 The Hackathon template comes with the following full-stack features:

[Descope](https://descope.com) NextAuth authentication 🔐 <br/>
Protected pages & API routes with NextAuth. <br/>
Next.js pages router, API routing protocols, and NextAuth integrations. <br/>
✅ A fully and easily customizable Home screen which features an About, Speakers, Sponsors, and FAQ section. <br/>
A dedicated Team page to showcase all contributors. <br/>
A Dashboard page for Hackers to complete onboarding forms, acceptance status, and hackathon announcements. <br/>
✅ Fully responsive UI (mobile, tablet, computer). <br/>
✅ Airtable backend for hackers to signup and view hackathon details. <br/>
- [Descope](https://descope.com) NextAuth authentication 🔐 <br/>
- Protected pages & API routes with NextAuth. <br/>
- The latest Next.js app router, server & client components. <br/>
- Fully customizable Home screen which features an About, Speakers, Sponsors, and FAQ section. <br/>
- A dedicated Team page to showcase all contributors. <br/>
- A Dashboard page for Hackers to complete onboarding forms, acceptance status, and hackathon announcements. <br/>
- Airtable backend for hackers to signup and view hackathon details. <br/>
- Fully responsive UI (mobile, tablet, computer). <br/>

## ✨ Made with...

- NextAuth (Auth.js) using Descope provider
- Flowbite
- Tailwind CSS

## 🚀 Deploy

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdescope-sample-apps%2Fnextjs-hackathon-template-pages&env=NEXTAUTH_URL,AIRTABLE_FORM_EMBED,AIRTABLE_TABLE_NAME,AIRTABLE_BASE,AIRTABLE_PERSONAL_ACCESS_TOKEN,DESCOPE_ACCESS_KEY,DESCOPE_PROJECT_ID,NEXTAUTH_SECRET)

## ⚙️ Setup: Local Testing

1. In the root directory of the project, copy the `.env.example` to `.env` by running `cp .env.example .env` and include the following:
Expand Down Expand Up @@ -134,6 +124,10 @@ our template data into these components as props that then render the data!
To learn more about creating a form and setting up Airtable as a database go to [Airtable.md](Airtable.md)!

## 🚀 Deploy

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdescope-sample-apps%2Fnextjs-hackathon-template-pages&env=NEXTAUTH_URL,AIRTABLE_FORM_EMBED,AIRTABLE_TABLE_NAME,AIRTABLE_BASE,AIRTABLE_PERSONAL_ACCESS_TOKEN,DESCOPE_ACCESS_KEY,DESCOPE_PROJECT_ID,NEXTAUTH_SECRET)

## 👨‍🍳 Gallery

<img src="./readme-assets/authhacks_1.png" />
Expand Down
Binary file modified readme-assets/authhacks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8c9fb7f

Please sign in to comment.