Skip to content
Homayoun edited this page Nov 3, 2024 · 6 revisions

πŸš€ Getting Started with Nexca

Prerequisites βœ…

Before starting, make sure you have:

  • Node.js version 18.17.0 or above 🟒

βš™οΈ Installation

  1. Clone the Repository πŸ“₯

    git clone https://github.com/homayunmmdy/nexca.git
  2. Navigate to the Project Directory πŸ“‚

    cd nexca
  3. Install Dependencies πŸ“¦

    npm install

πŸ”§ Configuration

  1. Copy and Rename Environment File πŸ“

    cp .env.sample .env.local
  2. Customize the Configuration πŸ› οΈ

    • Open the .env.local file.
    • Edit the values according to your setup to ensure all necessary environment variables are configured.

▢️ Running the Project

  1. Start the Development Server πŸš€

    npm run dev
  2. Access the Admin Panel πŸ–₯️

  3. Enjoy the Admin Panel πŸŽ‰


☁️ Hosting on Vercel (Recommended)

Why Vercel? 🌐

Vercel is perfect for hosting Node.js applications, especially those using Next.js. It provides automatic CI/CD, custom domains, and easy environment management.

Steps to Deploy 🌍

  1. Sign Up or Log In to Vercel πŸ”‘

    • Go to Vercel's website and sign up if you don’t have an account.
    • Log in to your account.
  2. Connect Your Git Repository πŸ”—

    • Click the New Project button.
    • Select the repository you cloned (nexca) and follow the prompts.
  3. Configure Environment Variables πŸ”’

    • During setup, Vercel will ask for environment variables.
    • Enter the same variables as in your .env.local file.
  4. Deploy the Project πŸš€

    • Click Deploy to build and deploy your application.
  5. Access Your Deployed Application 🌎

    • After deployment, Vercel provides a live URL to access the admin panel.

πŸ“· Screenshots

Here's a quick preview of Nexca:

  1. Homepage 🏠
    3

  2. Admin Panel πŸ› οΈ
    2

  3. Landing Page 🌐
    1