Merge branch 'main' into main

love-sonkar · web-flow · commit 43686e4ca017 · 2024-10-03T09:48:56.000+05:30
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -463,6 +463,16 @@
         "code",
         "ideas"
       ]
+    },
+    {
+      "login": "SharizHussain",
+      "name": "SharizHussain",
+      "avatar_url": "https://avatars.githubusercontent.com/u/155846046?v=4",
+      "profile": "https://github.com/SharizHussain",
+      "contributions": [
+        "bug",
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,
diff --git a/.env.example b/.env.example
@@ -0,0 +1,9 @@
+AUTH_SECRET="" # A random string
+AUTH_URL="" # Should be http://localhost:3000 for local development
+AUTH_GITHUB_ID=""
+AUTH_GITHUB_SECRET=""
+XATA_API_KEY=""
+XATA_BRANCH="" # Default should be "main"
+
+NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME="" # Optional
+NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="" # Optional
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@
 /node_modules
 /.pnp
 .pnp.js
+package-lock.json
 
 # testing
 /coverage
diff --git a/.xata/version/compatibility.json b/.xata/version/compatibility.json
@@ -0,0 +1 @@
+{"@xata.io/cli":{"latest":"0.16.11","compatibility":[{"range":">=0.0.0"}]},"@xata.io/client":{"latest":"0.30.1","compatibility":[{"range":">=0.0.0"}]}}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,100 @@
+# Contributing to Hacktoberfest Projects Finder
+
+Thank you for your interest in contributing to the Hacktoberfest Projects Finder! We welcome contributions from everyone. This document will guide you through the process of setting up the project locally and creating a GitHub OAuth application.
+
+## Setting Up the Project
+
+1. Fork the repository on GitHub.
+2. Clone your forked repository:
+```sh
+git clone https://github.com/your-username/hacktoberfest-projects.git
+```
+3. Navigate to the project directory:
+```sh
+cd hacktoberfest-projects
+```
+4. Install dependencies (we recommend using `pnpm`):
+```sh
+pnpm install
+```
+5. Copy the `.env.example` file to `.env.local` and fill in the required environment variables.
+
+## Creating a GitHub OAuth Application
+
+To use GitHub authentication in the project, you need to create a GitHub OAuth application. Follow these steps:
+
+1. Go to your GitHub account settings.
+2. Navigate to "Developer settings" > "OAuth Apps".
+3. Click on "New OAuth App".
+4. Fill in the application details:
+- Application name: "Hacktoberfest Projects Finder" (or your preferred name)
+- Homepage URL: `http://localhost:3000` (for local development)
+- Authorization callback URL: `http://localhost:3000/api/auth/callback/github`
+5. Click "Register application".
+6. On the next page, you'll see your Client ID. Click "Generate a new client secret" to create your Client Secret.
+7. Copy the Client ID and Client Secret to your `.env.local` file.
+
+## Setting Up Xata
+
+Xata is used as the database for this project. Follow these steps to set it up:
+
+1. Sign up for a Xata account at https://xata.io/
+2. Install the Xata CLI globally:
+```sh
+npm install -g "@xata.io/cli@latest"
+```
+3. Authenticate with Xata:
+```sh
+xata auth login
+```
+4. Run the migration:
+```sh
+xata push main
+```
+
+## Environment Variables
+
+Create a `.env.local` file in the root of the project and add the following variables:
+```sh
+AUTH_SECRET="" # A random string
+AUTH_URL="" # Should be http://localhost:3000 for local development
+AUTH_GITHUB_ID=""
+AUTH_GITHUB_SECRET=""
+XATA_API_KEY=""
+XATA_BRANCH="" # Default should be "main"
+
+NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME="" # Optional
+NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="" # Optional
+```
+
+Make sure to fill in the required values for each variable. The `AUTH_SECRET` should be a random string, and `AUTH_URL` should be set to `http://localhost:3000` for local development. The `XATA_BRANCH` should typically be set to "main" unless you're using a different branch. Remember that the `NEXT_PUBLIC_` variables are optional.
+
+## Running the Project
+
+After setting up the environment variables, you can start the development server:
+```sh
+pnpm dev
+```
+
+The application should now be running at `http://localhost:3000`.
+
+## Making Contributions
+
+1. Create a new branch for your feature or bug fix:
+```sh
+git checkout -b feature/your-feature-name
+```
+2. Make your changes and commit them with a descriptive commit message.
+3. Push your changes to your fork:
+```sh
+git push origin feature/your-feature-name
+```
+4. Create a pull request from your fork to the main repository.
+
+Please ensure your code follows the project's coding standards and includes appropriate tests if applicable.
+
+## Questions or Issues
+
+If you have any questions or run into issues, please open an issue in the GitHub repository. We're here to help!
+
+Thank you for contributing to the Hacktoberfest Projects Finder!
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ A Web app that lets you find eligible repositories for Hacktoberfest!
 Use it here - https://finder.usmans.me
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-47-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-48-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 <a href="https://gitmoji.dev">
   <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
@@ -15,57 +15,13 @@ Use it here - https://finder.usmans.me
 
 ## Contributing
 
-Contributions are always welcome!
+We welcome contributions from everyone! If you're interested in helping improve the Hacktoberfest Projects Finder, please take a look at our [CONTRIBUTING.md](CONTRIBUTING.md) file. It contains detailed information on how to set up the project locally, create a GitHub OAuth application, set up the Xata database, and submit your contributions.
 
 > Pull Requests about adding languages will not be merged, if you want to suggest adding a new language, please [create an issue](https://github.com/max-programming/hacktoberfest-projects/issues/new) for that 🙂
 
 ### Run Locally
 
-Clone the project
-
-```bash
-git clone https://github.com/max-programming/hacktoberfest-projects.git
-```
-
-Go to the project directory
-
-```bash
-cd hacktoberfest-projects
-```
-
-Install dependencies (if you want to use `npm` you can use but its recommended to use `pnpm`)
-
-```bash
-pnpm i
-```
-
-Start the server
-
-```bash
-pnpm dev
-```
-
-### Setup Xata
-
-You will need to sign up with Xata and set up a database for the build. After registering for an account, please proceed with the following steps.
-
-#### Installation
-
-```
-npm install -g "@xata.io/cli@latest"
-```
-#### Authentication
-```
-xata auth login
-```
-
-#### Migration
-
-Change DB settings in xata.ts and .xatarc (do not commit this) and run migration
-
-```
-xata push main
-```
+Follow the steps in the [CONTRIBUTING.md](CONTRIBUTING.md) file to set up the project locally.
 
 ## Tech Stack
 
@@ -157,6 +113,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="http://jamesshopland.com"><img src="https://avatars.githubusercontent.com/u/5064896?v=4?s=100" width="100px;" alt="James Shopland"/><br /><sub><b>James Shopland</b></sub></a><br /><a href="https://github.com/max-programming/hacktoberfest-projects/commits?author=jolbol1" title="Code">💻</a> <a href="https://github.com/max-programming/hacktoberfest-projects/issues?q=author%3Ajolbol1" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://alone-y154.github.io/Portfolio-Website/"><img src="https://avatars.githubusercontent.com/u/72192888?v=4?s=100" width="100px;" alt="Yashwanth Krishna"/><br /><sub><b>Yashwanth Krishna</b></sub></a><br /><a href="#design-Alone-Y154" title="Design">🎨</a> <a href="https://github.com/max-programming/hacktoberfest-projects/commits?author=Alone-Y154" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/massdx"><img src="https://avatars.githubusercontent.com/u/63166764?v=4?s=100" width="100px;" alt="Massahoud"/><br /><sub><b>Massahoud</b></sub></a><br /><a href="https://github.com/max-programming/hacktoberfest-projects/commits?author=massdx" title="Code">💻</a> <a href="#ideas-massdx" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/SharizHussain"><img src="https://avatars.githubusercontent.com/u/155846046?v=4?s=100" width="100px;" alt="SharizHussain"/><br /><sub><b>SharizHussain</b></sub></a><br /><a href="https://github.com/max-programming/hacktoberfest-projects/issues?q=author%3ASharizHussain" title="Bug reports">🐛</a> <a href="https://github.com/max-programming/hacktoberfest-projects/commits?author=SharizHussain" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>
diff --git a/src/app/(public)/_components/button.tsx b/src/app/(public)/_components/button.tsx
@@ -11,7 +11,7 @@ export function Button({
   ...props
 }: PropsWithChildren<ButtonProps>) {
   return (
-    <div className="relative inline-block m-3 group w-fit">
+    <div className="relative inline-block group w-fit">
       <button
         className={cn(
           'bg-hacktoberfest-black hover:bg-hacktoberfest-dark-green btn btn-lg text-hacktoberfest-light rounded-2xl leading-none border-none h-auto p-2',
diff --git a/src/app/(public)/_components/header.tsx b/src/app/(public)/_components/header.tsx
@@ -26,7 +26,7 @@ export async function Header() {
 
           <div className="flex gap-2 lg:ml-40">
             <form action={session ? signOutAction : signInAction}>
-              <button className="text-white border-white btn btn-ghost border-1 text-nowrap">
+              <button className="text-white border-white btn btn-ghost border-1 text-nowrap ms-4">
                 {session && session.user ? 'Sign Out' : 'Sign In'}
               </button>
             </form>
diff --git a/src/app/(public)/repos/[language]/_components/repo-card.tsx b/src/app/(public)/repos/[language]/_components/repo-card.tsx
@@ -2,6 +2,7 @@ import type { RepoItem } from '@/types';
 import { emojify } from '@twuni/emojify';
 import { GoIssueOpened, GoRepoForked, GoStar } from 'react-icons/go';
 import { ReportButton } from './report-button';
+import { cn } from '@/lib/utils';
 
 const MAX_DESCRIPTION_LENGTH = 100;
 const MAX_TOPICS_DISPLAY = 3;
@@ -16,7 +17,7 @@ interface RepoCardProps {
 
 export function RepoCard({ repo }: RepoCardProps) {
   const truncatedDescription =
-    repo.description.length > MAX_DESCRIPTION_LENGTH
+    repo.description?.length > MAX_DESCRIPTION_LENGTH
       ? repo.description.substring(0, MAX_DESCRIPTION_LENGTH) + '...'
       : repo.description;
 
@@ -28,7 +29,7 @@ export function RepoCard({ repo }: RepoCardProps) {
   });
 
   const displayedTopics = sortedTopics.slice(0, MAX_TOPICS_DISPLAY);
-  const hasMoreTopics = sortedTopics.length > MAX_TOPICS_DISPLAY;
+  const hasMoreTopics = sortedTopics?.length > MAX_TOPICS_DISPLAY;
 
   return (
     <section className="transition duration-300 shadow-sm card bg-hacktoberfest-black ring-1 ring-hacktoberfest-light-pink hover:scale-105 hover:shadow-2xl hover:shadow-hacktoberfest-deep-pink">
@@ -63,7 +64,7 @@ export function RepoCard({ repo }: RepoCardProps) {
 
           <h6 className="my-5 text-lg text-hacktoberfest-beige">
             {emojify(truncatedDescription)}
-            {repo.description.length > MAX_DESCRIPTION_LENGTH && (
+            {repo.description?.length > MAX_DESCRIPTION_LENGTH && (
               <a
                 href={repo.html_url + '?ref=finder.usmans.me'}
                 target="_blank"
@@ -82,11 +83,12 @@ export function RepoCard({ repo }: RepoCardProps) {
                 href={`https://github.com/topics/${topic}`}
                 target="_blank"
                 rel="noreferrer"
-                className={`badge inline px-3 py-0.5 h-auto ${
+                className={cn(
+                  'badge inline px-3 py-0.5 h-auto',
                   topic === 'hacktoberfest'
                     ? 'bg-hacktoberfest-light-green text-hacktoberfest-dark-green'
                     : 'bg-hacktoberfest-deep-pink text-hacktoberfest-light-pink'
-                }`}
+                )}
               >
                 {topic}
               </a>
@@ -98,7 +100,7 @@ export function RepoCard({ repo }: RepoCardProps) {
         </div>
 
         {/* stars and forks cards */}
-        <div className="flex flex-wrap justify-between gap-4 mt-8 cursor-pointer container-query text-neutral-100">
+        <div className="flex flex-wrap justify-between mt-8 gap-4 cursor-pointer container-query text-neutral-100">
           <a
             href={`${repo.html_url}/stargazers?ref=finder.usmans.me`}
             target="_blank"
diff --git a/src/app/(public)/repos/[language]/_components/sorter.tsx b/src/app/(public)/repos/[language]/_components/sorter.tsx
@@ -117,15 +117,15 @@ export function Sorter() {
 
   return (
     <div className="flex items-center justify-center gap-2 mb-8">
-      <div className="dropdown dropdown-hover">
+      <div className="dropdown group dropdown-hover">
         <Button
           tabIndex={0}
           className="hover:bg-hacktoberfest-green hover:text-hacktoberfest-dark-green"
         >
           <Code className="w-6 h-6 mr-2" />
           Language
         </Button>
-        <div className="z-50 h-64 p-2 overflow-y-scroll shadow dropdown-content bg-base-100 rounded-box w-60">
+        <div className="z-50 h-64 p-2 overflow-y-scroll shadow dropdown-content hidden group-hover:block bg-base-100 rounded-box w-60">
           <ul tabIndex={0} className="menu menu-vertical">
             {mainLanguages.sort(sortByName).map(language => (
               <li key={language} onClick={handleClick}>
@@ -137,15 +137,15 @@ export function Sorter() {
           </ul>
         </div>
       </div>
-      <div className="dropdown dropdown-hover">
+      <div className="dropdown dropdown-hover group">
         <Button
           tabIndex={0}
           className="hover:bg-hacktoberfest-green hover:text-hacktoberfest-dark-green"
         >
           <ArrowUpAZ className="w-6 h-6 mr-2" />
           {selectedSort()}
         </Button>
-        <div className="z-50 h-64 p-2 overflow-y-scroll shadow dropdown-content bg-base-100 rounded-box w-60">
+        <div className="z-50 h-64 p-2 overflow-y-scroll shadow dropdown-content hidden group-hover:block -ml-16 bg-base-100 rounded-box w-60">
           <ul tabIndex={0} className="menu menu-vertical">
             {navigationItems.map((item, index) => {
               const sp = item.onSelect(new URLSearchParams(searchParams));
diff --git a/src/app/(public)/repos/[language]/page.tsx b/src/app/(public)/repos/[language]/page.tsx
@@ -100,7 +100,7 @@ async function getRepos(
   apiUrl.searchParams.set('order', order.toString());
   apiUrl.searchParams.set(
     'q',
-    `topic:hacktoberfest language:${encodeURIComponent(language)} ${searchQuery} ${starsQuery}`
+    `topic:hacktoberfest language:${language} ${searchQuery} ${starsQuery}`
   );
 
   const headers: HeadersInit = {
@@ -133,7 +133,7 @@ async function getRepos(
     return !repo.archived && !reports.find(report => report.repoId === repo.id);
   });
 
-  if (!repos.items || repos.items.length < 1) notFound();
+  if (!Array.isArray(repos.items) || repos.items?.length < 1) notFound();
 
   return {
     page: +page.toString(),
@@ -144,7 +144,7 @@ async function getRepos(
 
 async function getReportedRepos() {
   const client = getXataClient();
-  const reports = await client.db.reports
+  const reports = await client.db.reports 
     .select(['repoId'])
     .filter({ valid: false })
     .getMany();
diff --git a/src/app/layout.tsx b/src/app/layout.tsx
@@ -6,6 +6,7 @@ import { Toaster } from 'react-hot-toast';
 import { SessionProvider } from 'next-auth/react';
 import { Footer } from '@/components/footer';
 import { ReportModal } from '@/components/report-modal';
+import { env } from '@/env.mjs';
 
 const spaceGrotesk = Space_Grotesk({
   subsets: ['latin'],
@@ -24,10 +25,10 @@ export default function RootLayout({ children }: React.PropsWithChildren) {
           <ReportModal />
         </SessionProvider>
         <Toaster position="bottom-right" />
-        {process.env.NEXT_PUBLIC_ANALYTICS_WEBSITE_ID && (
+        {env.NEXT_PUBLIC_ANALYTICS_WEBSITE_ID && (
           <Script
             src="https://cloud.umami.is/script.js"
-            data-website-id={process.env.NEXT_PUBLIC_ANALYTICS_WEBSITE_ID}
+            data-website-id={env.NEXT_PUBLIC_ANALYTICS_WEBSITE_ID}
             strategy="lazyOnload"
           />
         )}
diff --git a/src/components/footer.tsx b/src/components/footer.tsx
@@ -8,7 +8,7 @@ const formatter = new Intl.ListFormat('en', {
 
 export function Footer() {
   return (
-    <footer className="text-center text-white py-4 text-lg border-t-[0.5px] border-dashed border-t-hacktoberfest-light-green">
+    <footer className="text-center pb-10 text-white py-4 text-lg border-t-[0.5px] border-dashed border-t-hacktoberfest-light-green">
       <div className="container px-4 mx-auto">
         <Link href="/contributors">
           Made with <span className="text-red-500">💗</span> by{' '}
diff --git a/src/env.mjs b/src/env.mjs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"@xata.io/cli":{"latest":"0.16.11","compatibility":[{"range":">=0.0.0"}]},"@xata.io/client":{"latest":"0.30.1","compatibility":[{"range":">=0.0.0"}]}}`