https://github.com/nexussjcet/nexus-spaces
https://github.com/nexussjcet/nexus-spaces
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/nexussjcet/nexus-spaces
- Owner: nexussjcet
- License: gpl-3.0
- Created: 2025-01-06T16:39:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-02-15T14:35:25.000Z (8 months ago)
- Last Synced: 2025-05-06T00:45:15.197Z (5 months ago)
- Language: TypeScript
- Homepage: https://try-nexus-spaces.vercel.app/
- Size: 943 KB
- Stars: 6
- Watchers: 2
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Nexus Spaces
Nexus Spaces is an AI-driven social media platform where SJCET students can connect with developers, designers, and other skilled individuals.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Step 1: Install Dependencies](#step-1-install-dependencies)
- [Step 2: Set Up Environment Variables](#step-2-set-up-environment-variables-env)
- [Step 3: Set Up Supabase](#step-3-set-up-supabase)
- [Step 4: Set Up GitHub OAuth](#step-4-set-up-github-oauth)
- [Step 5: Generate an Authentication Secret Key](#step-5-generate-an-authentication-secret-key)
- [Step 6: Set Up GROQ API Key](#step-6-set-up-groq-api-key)
- [Step 7: Push Database Schema](#step-7-push-database-schema-essential-step)
- [Step 8: Run the Application](#step-8-run-the-application)
- [Troubleshooting](#troubleshooting)
---
## Project Setup
### Prerequisites
Before you start, ensure you have the following installed:
- [Node.js](https://nodejs.org/)
### Building and Running Locally
Follow these steps to set up the project in your local development environment:
---
## Step 1: Install Dependencies
1. Clone the repository to your local machine.
2. Navigate to the project folder.
3. Run the following command to install required dependencies:
```bash
npm install
```
---
## Step 2: Set Up Environment Variables (.env)
1. Refer to the `env.example` file for examples of the required environment variables.
2. Create a `.env` file in the root of the project.
3. Copy and configure the variables from `env.example` into your `.env` file.
Given Below is the format:
```plaintext
- `DATABASE_URL`: Your PostgreSQL database URL
- `AUTH_SECRET`: Generate using `openssl rand -base64 32`
- `AUTH_GITHUB_ID`: Your GitHub OAuth App ID
- `AUTH_GITHUB_SECRET`: Your GitHub OAuth App Secret
- `GROQ_API_KEY`: Your GROQ API key (get it from [groq.com](https://console.groq.com/keys)
```
> **⚠️ Caution:** Do not include your secret keys in the example .env.example file. Keep them private in your .env file.
---
## Step 3: Set Up Supabase
1. Create a [Supabase](https://supabase.com/) account.
2. Create a new project within Supabase.
3. Navigate to **Connect > ORMs**.
4. Under **Tools**, select **Drizzle**.
5. Copy the database URL into the `DATABASE_URL` variable in your `.env` file.
6. Enter the password you set for the project into your `.env` file.
---
## Step 4: Set Up GitHub OAuth
1. Go to [GitHub Developers](https://github.com/settings/developers).
2. Create a **New OAuth App**.
3. Provide the following details:
- **Homepage URL:** `http://localhost:3000`
- **Authorization Callback URL:** `http://localhost:3000/api/auth/callback/github`
4. Copy the generated Client ID and paste it into `AUTH_GITHUB_ID` in your `.env` file.
5. Copy the generated Client Secret and paste it into `AUTH_GITHUB_SECRET` in your `.env` file.
---
## Step 5: Generate an Authentication Secret Key
1. Open your terminal in the project directory.
2. Run the following command to install any necessary packages:
```bash
npx auth
```
3. Generate the secret key by running:
```bash
npx auth secret
```
4. Copy and paste the generated key into `AUTH_SECRET` in your `.env` file.
---
## Step 6: Set Up GROQ API Key
1. Go to [GROQ Console](https://console.groq.com/).
2. Create a new account or sign in if you already have one.
3. Navigate to the **API Keys** section in the dashboard.
4. Click on **Create API Key**.
5. Give your API key a name (e.g., "Nexus Spaces Development").
6. Copy the generated API key.
7. Paste the key into `GROQ_API_KEY` in your `.env` file.
> **Note:** Keep your API key secure and never commit it to version control.
---
## Step 7: Push Database Schema (Essential Step)
1. Push the database schema to Supabase by running:
```bash
npm run db:push
```
> **Note:** The `db:push` command synchronizes your Schema with your database schema without using migrations. This is particularly useful during prototyping and local development.
---
## Step 8: Run the Application
1. Start the development server by running:
```bash
npm run dev
```
2. Open your browser and navigate to:
[http://localhost:3000](http://localhost:3000)
---
### Troubleshooting
If you encounter any issues during setup, double-check:
- Your `.env` file configuration.
- That you’ve run `npm install` and `npm run db:push` correctly.
- Your Supabase project setup.
For further assistance, refer to the official documentation of [Supabase](https://supabase.com/docs) or [Next.js](https://nextjs.org/docs).
---