Frontend Setup 🚀

  1. Fork and clone the repository:

    git clone [<https://github.com/your-username/GetIt.git>]
    
  2. Navigate to the front end directory:

    cd GetIt
    cd frontend
    
  3. Run the development server: Choose one of the following commands based on your package manager:

    pnpm install
    pnpm dev
    

    or

    npm install
    npm run dev
    

Backend Setup 🐍

The back end requires Python 3.10. If you have a different version (e.g., 3.13), it's recommended to use pyenv to manage Python versions.

  1. Install pyenv (if you don't have it): This example uses yay for Arch-based distributions. Use your system's package manager if different (e.g., brew install pyenv on macOS).

    yay -S pyenv
    
  2. Configure your shell for pyenv: Edit your shell configuration file (e.g., ~/.zshrc for Zsh or ~/.bashrc for Bash) and add the following lines:

    export PYENV_ROOT="$HOME/.pyenv"
    export PATH="$PYENV_ROOT/bin:$PATH"
    eval "$(pyenv init --path)"
    eval "$(pyenv virtualenv-init -)"
    
  3. Reload your shell configuration:

    source ~/.zshrc
    # or source ~/.bashrc for Bash
    
  4. Verify pyenv installation:

    pyenv --version
    
  5. Install Python 3.10.12 (if not already installed):

    pyenv install 3.10.12
    
  6. Set Python 3.10.12 locally for your project: Navigate to your back end project directory:

    cd /path/to/your/project
    

    Then set the local Python version:

    pyenv local 3.10.12
    
  7. Verify the Python version for the project:

    python --version
    

    This should output Python 3.10.12.

  8. Run the run.sh file

  9. Create superuser and Login into Django admin at /admin with same username and password

  python manage.py createsuperuser

1. Open PowerShell as Administrator