Added contributing guide, new environment variable and env example file

Author: max-programming

.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

CONTRIBUTING.md

@@ -0,0 +1,101 @@
+# 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. Update the database settings in `xata.ts` and `.xatarc` files (do not commit these changes).
+5. 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!

README.md

@@ -15,7 +15,7 @@ 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 🙂
 

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"
           />
         )}

src/env.mjs

@@ -6,15 +6,18 @@ export const env = createEnv({
     AUTH_GITHUB_SECRET: z.string().min(1, 'AUTH_GITHUB_SECRET is required'),
     AUTH_GITHUB_ID: z.string().min(1, 'AUTH_GITHUB_ID is required'),
     AUTH_SECRET: z.string().min(1, 'AUTH_SECRET is required'),
-    AUTH_GITHUB_TOKEN: z.string().optional(),
-    XATA_BRANCH: z.string().optional(),
-    XATA_API_KEY: z.string().optional()
+    XATA_BRANCH: z.string().min(1, 'XATA_BRANCH is required'),
+    XATA_API_KEY: z.string().min(1, 'XATA_API_KEY is required'),
+    AUTH_GITHUB_TOKEN: z.string().optional()
   },
   client: {
-    NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME: z.string().optional()
+    NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME: z.string().optional(),
+    NEXT_PUBLIC_ANALYTICS_WEBSITE_ID: z.string().uuid().optional()
   },
   experimental__runtimeEnv: {
     NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME:
-      process.env.NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME
+      process.env.NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME,
+    NEXT_PUBLIC_ANALYTICS_WEBSITE_ID:
+      process.env.NEXT_PUBLIC_ANALYTICS_WEBSITE_ID
   }
 });