-
Notifications
You must be signed in to change notification settings - Fork 2
update readme #60
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
Merged
Merged
update readme #60
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d18acb4
update readme
2914905
Add initial server setup with Bun, including configuration files and …
yashdev9274 a43b3fa
add dependencies and add Prisma configuration for supercode-cli datab…
yashdev9274 69b9540
Update documentation and restructure content: rename intro page to da…
yashdev9274 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| import { redirect } from "next/navigation" | ||
|
|
||
| export default function DocsIndex() { | ||
| redirect("/docs/intro") | ||
| redirect("/docs/dashboard-intro") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| title: Authentication | ||
| description: Setting up GitHub OAuth authentication. | ||
| --- | ||
|
|
||
| # Authentication | ||
|
|
||
| Supercode uses GitHub OAuth for secure authentication. This allows you to sign in with your GitHub account and access your repositories. | ||
|
|
||
| ## Sign In | ||
|
|
||
| 1. Visit [supercli.com](https://supercli.com) | ||
| 2. Click **Sign In** | ||
| 3. You'll be redirected to GitHub for authorization | ||
| 4. Authorize the Supercode application | ||
| 5. You'll be redirected back to the dashboard | ||
|
|
||
| ## GitHub OAuth Setup | ||
|
|
||
| ### For Users | ||
|
|
||
| The OAuth flow is handled automatically. When you sign in: | ||
|
|
||
| 1. GitHub will ask you to authorize Supercode | ||
| 2. Grant access to your GitHub account | ||
| 3. You'll be able to view and connect your repositories | ||
|
|
||
| ### Required Permissions | ||
|
|
||
| Supercode requests the following GitHub permissions: | ||
| - **Read user profile** - To display your account info | ||
| - **Read repositories** - To list and display your repos | ||
| - **Read repository contents** - To analyze code when using Terminal | ||
|
|
||
| ## Session Management | ||
|
|
||
| - Sessions are managed via secure HTTP-only cookies | ||
| - Session tokens are encrypted with `BETTER_AUTH_SECRET` | ||
| - Sessions persist across browser sessions | ||
|
|
||
| ## Security | ||
|
|
||
| - Passwords are never stored (GitHub handles authentication) | ||
| - API keys for AI providers are stored per-user in encrypted form | ||
| - All requests are served over HTTPS in production | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Authorization Failed | ||
|
|
||
| If GitHub authorization fails: | ||
| 1. Check that you're logged into the correct GitHub account | ||
| 2. Ensure the Supercode app hasn't been revoked in GitHub settings | ||
| 3. Try clearing browser cookies and signing in again | ||
|
|
||
| ### Session Expired | ||
|
|
||
| Sessions expire after 30 days of inactivity. Simply sign in again to continue. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| title: Dashboard | ||
| description: Overview of the Supercode Dashboard. | ||
| --- | ||
|
|
||
| # Dashboard | ||
|
|
||
| The Supercode Dashboard is a web-based interface for managing your account, connecting GitHub repositories, and accessing the Terminal AI coding agent. | ||
|
|
||
| ## Features | ||
|
|
||
| - **Authentication** - Secure sign-in with GitHub OAuth | ||
| - **Repository Management** - Connect and manage your GitHub repositories | ||
| - **Terminal Access** - Launch the AI coding terminal for your projects | ||
| - **Settings** - Manage your profile and connected repositories | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Sign in at [supercli.vercel.app](https://supercli.vercel.app) using GitHub | ||
| 2. Navigate to the **Providers** page to connect your repositories | ||
| 3. Access the **Terminal** to start AI-assisted coding | ||
|
|
||
| ## Navigation | ||
|
|
||
| | Page | Description | | ||
| |------|-------------| | ||
| | Dashboard | Main overview and quick actions | | ||
| | Providers | Connect and manage GitHub repositories | | ||
| | Terminal | Launch the AI coding agent | | ||
| | Settings | Profile and account management | | ||
|
|
||
| ## Tech Stack | ||
|
|
||
| The dashboard is built with: | ||
| - Next.js 16 (App Router) | ||
| - React 19 | ||
| - TypeScript | ||
| - Tailwind CSS v4 | ||
| - Better-Auth for authentication | ||
| - Prisma with PostgreSQL | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Use one canonical sign-in URL across docs.
Line 19 points to
supercli.vercel.app, while the auth page points tosupercli.com. Pick one canonical URL (or use a relative route) to avoid sending users to different environments.🤖 Prompt for AI Agents