Backend

• Next.js API Routes - Serverless functions
• MongoDB - NoSQL database
• Mongoose - ODM for MongoDB
• NextAuth v5 - Authentication
• Groq SDK - AI chat completions

Deployment

• Netlify - Cloud hosting platform
• Netlify Edge Functions - Edge computing
• Netlify Images - Image optimization

🚀 Getting Started

Prerequisites

• Node.js 20 or higher
• npm, yarn, or pnpm
• MongoDB connection string
• Google OAuth credentials (optional)

Installation

1. Clone the repository

git clone https://github.com/user-synax/nomadbase-goa.git
cd nomadbase-goa

2. Install dependencies

npm install
# or
yarn install
# or
pnpm install

3. Set up environment variables

Create a .env.local file in the root directory:

# MongoDB
MONGODB_URI=mongodb://localhost:27017/nomadbase-goa

# Google OAuth
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret

# NextAuth
NEXTAUTH_SECRET=your_nextauth_secret
NEXTAUTH_URL=http://localhost:3000

# Groq AI
GROQ_API_KEY=your_groq_api_key

4. Run the development server

npm run dev
# or
yarn dev
# or
pnpm dev

5. Open your browser

Navigate to http://localhost:3000

📁 Project Structure

nomadbase-goa/
├── app/
│   ├── (auth)/              # Authentication routes
│   │   └── signin/          # Sign-in page
│   ├── (root)/              # Main application routes
│   │   ├── assistant/       # AI assistant page
│   │   ├── colivings/       # Colivings listing
│   │   ├── page.tsx         # Landing page
│   │   ├── profile/         # User profiles
│   │   └── spaces/          # Co-working spaces
│   ├── api/                 # API routes
│   │   ├── assistant/       # AI assistant API
│   │   ├── auth/            # Authentication API
│   │   ├── colivings/       # Colivings API
│   │   ├── community/       # Community API
│   │   ├── spaces/          # Spaces API
│   │   └── users/           # Users API
│   └── layout.tsx           # Root layout
├── components/
│   ├── assistant/           # Assistant components
│   ├── colivings/           # Coliving components
│   ├── profile/             # Profile components
│   ├── shared/              # Shared components
│   ├── spaces/              # Space components
│   └── ui/                  # UI components
├── lib/
│   ├── auth.js              # NextAuth configuration
│   └── db.js                # MongoDB connection
├── models/
│   ├── Coliving.js          # Coliving model
│   ├── Reply.js             # Reply model
│   ├── Review.js            # Review model
│   ├── Space.js             # Space model
│   ├── Thread.js            # Thread model
│   └── User.js              # User model
├── middleware.js            # Next.js middleware
├── netlify.toml             # Netlify configuration
├── .nvmrc                   # Node version
├── next.config.ts           # Next.js configuration
├── tailwind.config.ts       # Tailwind configuration
└── tsconfig.json            # TypeScript configuration

🔐 Authentication

Google OAuth Setup

1. Go to Google Cloud Console
2. Create a new project or select existing one
3. Enable Google+ API
4. Create OAuth 2.0 credentials
5. Add authorized redirect URIs:
   • http://localhost:3000/api/auth/callback/google (development)
   • https://nomadbase-goa.netlify.app/api/auth/callback/google (production)
6. Copy Client ID and Client Secret
7. Add to environment variables

Environment Variables

🚀 Deployment

Netlify

1. Connect your repository

   • Go to Netlify and add a new site
   • Import from GitHub
   • Select nomadbase-goa repository

2. Configure build settings

   [build]
     command = "npm run build"
     publish = ".next"
   

3. Set environment variables

   Add all required environment variables in Netlify site settings

4. Deploy

   • Netlify will automatically build and deploy
   • Configure custom domain if needed

Manual Deployment

npm run build
npm run start

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Next.js - The React framework
• Tailwind CSS - Utility-first CSS framework
• shadcn/ui - Beautiful component library
• Groq - Fast AI inference
• MongoDB - NoSQL database

📞 Contact

• Website: nomadbase-goa.netlify.app
• GitHub: user-synax/nomadbase-goa

Made with ❤️ for digital nomads in Goa

⬆ Back to Top