Repository navigation
docs: update README with project architecture and cover image - #3
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repository README to better describe the e-Vote platform, including a cover image, feature list, setup steps, and a high-level database schema overview.
Changes:
- Replaced the default Next.js template README with project-specific overview and features.
- Added a cover image and tech stack section.
- Added local setup instructions and a brief Supabase schema summary.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. | ||
| ## 🛠️ Tech Stack | ||
|
|
||
| - **Framework:** [Next.js 14](https://nextjs.org/) (App Router) |
|
|
||
| ## Learn More | ||
| ### 3. Set up environment variables | ||
| Create a `.env.local` file in the root of the project and populate it using the `.env.local.example` template: |
| - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
| NEXT_PUBLIC_SUPABASE_URL=https://... | ||
| NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJ... | ||
| SUPABASE_SERVICE_ROLE_KEY=eyJ... |
| ## 🚀 Features | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
| - **End-to-End Encryption:** Ballots are cast securely and tied to specific authenticated student credentials. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
just added an image and more description