-
Notifications
You must be signed in to change notification settings - Fork 0
Implement authentication module with OAuth2, JWT, and UI integration #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
1f2bc6e
c24ac0f
a8a7c47
f516916
fd24bdf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| { | ||
| "projectName": "frontend", | ||
| "mode": "file-router", | ||
| "typescript": true, | ||
| "packageManager": "bun", | ||
| "includeExamples": false, | ||
| "tailwind": true, | ||
| "projectPreset": "default", | ||
| "addOnOptions": {}, | ||
| "git": false, | ||
| "install": true, | ||
| "intent": true, | ||
| "routerOnly": false, | ||
| "version": 1, | ||
| "framework": "react", | ||
| "chosenAddOns": [ | ||
| "eslint", | ||
| "nitro", | ||
| "compiler", | ||
| "form", | ||
| "shadcn", | ||
| "t3env", | ||
| "tanstack-query" | ||
| ] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| node_modules | ||
| .DS_Store | ||
| dist | ||
| dist-ssr | ||
| *.local | ||
| .env | ||
| .nitro | ||
| .tanstack | ||
| .wrangler | ||
| .output | ||
| .vinxi | ||
| __unconfig* | ||
| todos.json | ||
| .vscode/ |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| package-lock.json | ||
| pnpm-lock.yaml | ||
| yarn.lock |
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,235 @@ | ||||||||||||||
| Welcome to your new TanStack Start app! | ||||||||||||||
|
|
||||||||||||||
| # Getting Started | ||||||||||||||
|
|
||||||||||||||
| To run this application: | ||||||||||||||
|
|
||||||||||||||
| ```bash | ||||||||||||||
| bun install | ||||||||||||||
| bun --bun run dev | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| # Building For Production | ||||||||||||||
|
|
||||||||||||||
| To build this application for production: | ||||||||||||||
|
|
||||||||||||||
| ```bash | ||||||||||||||
| bun --bun run build | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## Styling | ||||||||||||||
|
|
||||||||||||||
| This project uses [Tailwind CSS](https://tailwindcss.com/) for styling. | ||||||||||||||
|
|
||||||||||||||
| ### Removing Tailwind CSS | ||||||||||||||
|
|
||||||||||||||
| If you prefer not to use Tailwind CSS: | ||||||||||||||
|
|
||||||||||||||
| 1. Remove the demo pages in `src/routes/demo/` | ||||||||||||||
| 2. Replace the Tailwind import in `src/styles.css` with your own styles | ||||||||||||||
| 3. Remove `tailwindcss()` from the plugins array in `vite.config.ts` | ||||||||||||||
| 4. Remove `@tailwindcss/vite` and `tailwindcss` from `package.json` | ||||||||||||||
|
|
||||||||||||||
| ## Linting & Formatting | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| This project uses [eslint](https://eslint.org/) and [prettier](https://prettier.io/) for linting and formatting. Eslint is configured using [tanstack/eslint-config](https://tanstack.com/config/latest/docs/eslint). The following scripts are available: | ||||||||||||||
|
|
||||||||||||||
| ```bash | ||||||||||||||
| bun --bun run lint | ||||||||||||||
| bun --bun run format | ||||||||||||||
| bun --bun run check | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| ## Deploy with Nitro | ||||||||||||||
|
|
||||||||||||||
| This project uses Nitro as a generic server adapter, so it can run on any Node-compatible host. | ||||||||||||||
|
|
||||||||||||||
| ```bash | ||||||||||||||
| npm run build | ||||||||||||||
| node dist/server/index.mjs | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| The build output is a self-contained Node server. To deploy, push the `dist/` directory to your host (Render, Fly.io, your own VPS, etc.) and run the server command above. | ||||||||||||||
|
|
||||||||||||||
| For host-specific presets (Vercel, Netlify, Cloudflare, AWS Lambda, etc.) and tuning, see https://v3.nitro.build/deploy. | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| ## Shadcn | ||||||||||||||
|
|
||||||||||||||
| Add components using the latest version of [Shadcn](https://ui.shadcn.com/). | ||||||||||||||
|
|
||||||||||||||
| ```bash | ||||||||||||||
| pnpm dlx shadcn@latest add button | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| ## T3Env | ||||||||||||||
|
|
||||||||||||||
| - You can use T3Env to add type safety to your environment variables. | ||||||||||||||
| - Add Environment variables to the `src/env.mjs` file. | ||||||||||||||
| - Use the environment variables in your code. | ||||||||||||||
|
Comment on lines
+70
to
+72
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Correct the environment-module path. The environment schema is in -- Add Environment variables to the `src/env.mjs` file.
+- Add environment variables to the `src/env.ts` file.📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
|
|
||||||||||||||
| ### Usage | ||||||||||||||
|
|
||||||||||||||
| ```ts | ||||||||||||||
| import { env } from "#/env"; | ||||||||||||||
|
|
||||||||||||||
| console.log(env.VITE_APP_TITLE); | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| ## Routing | ||||||||||||||
|
|
||||||||||||||
| This project uses [TanStack Router](https://tanstack.com/router) with file-based routing. Routes are managed as files in `src/routes`. | ||||||||||||||
|
|
||||||||||||||
| ### Adding A Route | ||||||||||||||
|
|
||||||||||||||
| To add a new route to your application just add a new file in the `./src/routes` directory. | ||||||||||||||
|
|
||||||||||||||
| TanStack will automatically generate the content of the route file for you. | ||||||||||||||
|
|
||||||||||||||
| Now that you have two routes you can use a `Link` component to navigate between them. | ||||||||||||||
|
|
||||||||||||||
| ### Adding Links | ||||||||||||||
|
|
||||||||||||||
| To use SPA (Single Page Application) navigation you will need to import the `Link` component from `@tanstack/react-router`. | ||||||||||||||
|
|
||||||||||||||
| ```tsx | ||||||||||||||
| import { Link } from "@tanstack/react-router"; | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| Then anywhere in your JSX you can use it like so: | ||||||||||||||
|
|
||||||||||||||
| ```tsx | ||||||||||||||
| <Link to="/about">About</Link> | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| This will create a link that will navigate to the `/about` route. | ||||||||||||||
|
|
||||||||||||||
| More information on the `Link` component can be found in the [Link documentation](https://tanstack.com/router/v1/docs/framework/react/api/router/linkComponent). | ||||||||||||||
|
|
||||||||||||||
| ### Using A Layout | ||||||||||||||
|
|
||||||||||||||
| In the File Based Routing setup the layout is located in `src/routes/__root.tsx`. Anything you add to the root route will appear in all the routes. The route content will appear in the JSX where you render `{children}` in the `shellComponent`. | ||||||||||||||
|
|
||||||||||||||
| Here is an example layout that includes a header: | ||||||||||||||
|
|
||||||||||||||
| ```tsx | ||||||||||||||
| import { HeadContent, Scripts, createRootRoute } from '@tanstack/react-router' | ||||||||||||||
|
|
||||||||||||||
| export const Route = createRootRoute({ | ||||||||||||||
| head: () => ({ | ||||||||||||||
| meta: [ | ||||||||||||||
| { charSet: 'utf-8' }, | ||||||||||||||
| { name: 'viewport', content: 'width=device-width, initial-scale=1' }, | ||||||||||||||
| { title: 'My App' }, | ||||||||||||||
| ], | ||||||||||||||
| }), | ||||||||||||||
| shellComponent: ({ children }) => ( | ||||||||||||||
| <html lang="en"> | ||||||||||||||
| <head> | ||||||||||||||
| <HeadContent /> | ||||||||||||||
| </head> | ||||||||||||||
| <body> | ||||||||||||||
| <header> | ||||||||||||||
| <nav> | ||||||||||||||
| <Link to="/">Home</Link> | ||||||||||||||
| <Link to="/about">About</Link> | ||||||||||||||
| </nav> | ||||||||||||||
| </header> | ||||||||||||||
| {children} | ||||||||||||||
| <Scripts /> | ||||||||||||||
| </body> | ||||||||||||||
| </html> | ||||||||||||||
| ), | ||||||||||||||
| }) | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| More information on layouts can be found in the [Layouts documentation](https://tanstack.com/router/latest/docs/framework/react/guide/routing-concepts#layouts). | ||||||||||||||
|
|
||||||||||||||
| ## Server Functions | ||||||||||||||
|
|
||||||||||||||
| TanStack Start provides server functions that allow you to write server-side code that seamlessly integrates with your client components. | ||||||||||||||
|
|
||||||||||||||
| ```tsx | ||||||||||||||
| import { createServerFn } from '@tanstack/react-start' | ||||||||||||||
|
|
||||||||||||||
| const getServerTime = createServerFn({ | ||||||||||||||
| method: 'GET', | ||||||||||||||
| }).handler(async () => { | ||||||||||||||
| return new Date().toISOString() | ||||||||||||||
| }) | ||||||||||||||
|
|
||||||||||||||
| // Use in a component | ||||||||||||||
| function MyComponent() { | ||||||||||||||
| const [time, setTime] = useState('') | ||||||||||||||
|
|
||||||||||||||
| useEffect(() => { | ||||||||||||||
| getServerTime().then(setTime) | ||||||||||||||
| }, []) | ||||||||||||||
|
|
||||||||||||||
| return <div>Server time: {time}</div> | ||||||||||||||
| } | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## API Routes | ||||||||||||||
|
|
||||||||||||||
| You can create API routes by using the `server` property in your route definitions: | ||||||||||||||
|
|
||||||||||||||
| ```tsx | ||||||||||||||
| import { createFileRoute } from '@tanstack/react-router' | ||||||||||||||
| import { json } from '@tanstack/react-start' | ||||||||||||||
|
|
||||||||||||||
| export const Route = createFileRoute('/api/hello')({ | ||||||||||||||
| server: { | ||||||||||||||
| handlers: { | ||||||||||||||
| GET: () => json({ message: 'Hello, World!' }), | ||||||||||||||
| }, | ||||||||||||||
| }, | ||||||||||||||
| }) | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| ## Data Fetching | ||||||||||||||
|
|
||||||||||||||
| There are multiple ways to fetch data in your application. You can use TanStack Query to fetch data from a server. But you can also use the `loader` functionality built into TanStack Router to load the data for a route before it's rendered. | ||||||||||||||
|
|
||||||||||||||
| For example: | ||||||||||||||
|
|
||||||||||||||
| ```tsx | ||||||||||||||
| import { createFileRoute } from '@tanstack/react-router' | ||||||||||||||
|
|
||||||||||||||
| export const Route = createFileRoute('/people')({ | ||||||||||||||
| loader: async () => { | ||||||||||||||
| const response = await fetch('https://swapi.dev/api/people') | ||||||||||||||
| return response.json() | ||||||||||||||
| }, | ||||||||||||||
| component: PeopleComponent, | ||||||||||||||
| }) | ||||||||||||||
|
|
||||||||||||||
| function PeopleComponent() { | ||||||||||||||
| const data = Route.useLoaderData() | ||||||||||||||
| return ( | ||||||||||||||
| <ul> | ||||||||||||||
| {data.results.map((person) => ( | ||||||||||||||
| <li key={person.name}>{person.name}</li> | ||||||||||||||
| ))} | ||||||||||||||
| </ul> | ||||||||||||||
| ) | ||||||||||||||
| } | ||||||||||||||
| ``` | ||||||||||||||
|
|
||||||||||||||
| Loaders simplify your data fetching logic dramatically. Check out more information in the [Loader documentation](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#loader-parameters). | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| # Learn More | ||||||||||||||
|
|
||||||||||||||
| You can learn more about all of the offerings from TanStack in the [TanStack documentation](https://tanstack.com). | ||||||||||||||
|
|
||||||||||||||
| For TanStack Start specific documentation, visit [TanStack Start](https://tanstack.com/start). | ||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
Repository: Meet-08/CodeCompass
Length of output: 5079
Use Bun consistently in the README deployment commands.
Lines 49-51 use
npm run buildandnode dist/server/index.mjs, while the rest of this README uses Bun. Replace them withbun --bun run buildandbun dist/server/index.mjs; also update the Shadcn command at lines 63-65 frompnpm dlxtobunx.🤖 Prompt for AI Agents