talawa-api Code",id:"download-the-talawa-api-code",level:4},{value:"Production Environment Setup",id:"production-environment-setup",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Setup - Instructional Video",id:"setup---instructional-video",level:3},{value:"Setup - All Steps",id:"setup---all-steps",level:3},{value:"Configure the .env File",id:"configure-the-env-file",level:4},{value:"Add a JWT Secret to .env",id:"add-a-jwt-secret-to-env",level:5},{value:"Start the App",id:"start-the-app",level:4},{value:"Development Environment Setup",id:"development-environment-setup",level:2},{value:"Our Recommendations",id:"our-recommendations",level:3},{value:"Prerequisites",id:"prerequisites-1",level:3},{value:"Setup: Instructional Video",id:"setup-instructional-video",level:3},{value:"Setup: Using the CLI",id:"setup-using-the-cli",level:3},{value:"CLI Shutdown (Development)",id:"cli-shutdown-development",level:4},{value:"CLI Startup (Development)",id:"cli-startup-development",level:4},{value:"Import Sample Data",id:"import-sample-data",level:4},{value:"Setup: Using the VScode IDE",id:"setup-using-the-vscode-ide",level:3},{value:"Development Mode Operation",id:"development-mode-operation",level:4},{value:"Testing and Validation",id:"testing-and-validation",level:2}];function a(e){const n={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",h5:"h5",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"This document provides instructions on how to set up and start a running instance of talawa-api on your local system. The instructions are written to be followed in sequence so make sure to go through each of them step by step without skipping any sections."}),"\n",(0,t.jsx)(n.h2,{id:"the-env-configuration-file",children:"The .env Configuration File"}),"\n",(0,t.jsx)(n.p,{children:"You will need to configure the API to work correctly."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["The configuration file is called ",(0,t.jsx)(n.code,{children:".env"})," and must be placed in the root directory of the code."]}),"\n",(0,t.jsxs)(n.li,{children:["This table defines some the parameters required for smooth operation","\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Steps explaining the usage of the ",(0,t.jsx)(n.code,{children:".env"})," file will be found in subsequent sections"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"NOTE:"})," Visit our ",(0,t.jsx)(n.a,{href:"/docs/installation/environment-variables",children:"Environment Variables Page"})," for a comprehensive list of possibilities."]}),"\n"]}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:(0,t.jsx)(n.strong,{children:"Variable"})}),(0,t.jsx)(n.th,{children:(0,t.jsx)(n.strong,{children:"Use Case"})})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_ADMINISTRATOR_USER_EMAIL_ADDRESS"})}),(0,t.jsx)(n.td,{children:"Email address of the administrator user."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_ADMINISTRATOR_USER_NAME"})}),(0,t.jsx)(n.td,{children:"Username of the administrator user, used for admin login and identification."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_ADMINISTRATOR_USER_PASSWORD"})}),(0,t.jsx)(n.td,{children:"Password for the administrator user, used for admin login security."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_BASE_URL"})}),(0,t.jsx)(n.td,{children:"Base URL for the API, used for constructing API endpoints and routing requests."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_FACEBOOK_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's Facebook page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_GITHUB_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's GitHub repository, used for linking and integrating code repository."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_INSTAGRAM_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's Instagram page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_LINKEDIN_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's LinkedIn page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_NAME"})}),(0,t.jsx)(n.td,{children:"Name of the community, used for branding and identification within the application."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_REDDIT_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's Reddit page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_SLACK_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's Slack workspace, used for linking and integrating communication channels."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_WEBSITE_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's website, used for linking and integrating online presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_X_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's X (formerly Twitter) page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_YOUTUBE_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's YouTube channel, used for linking and integrating video content."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_JWT_SECRET"})}),(0,t.jsx)(n.td,{children:"Secret key for JWT(JSON Web Token) generation and validation, used for securing API authentication and authorization."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_MINIO_SECRET_KEY"})}),(0,t.jsx)(n.td,{children:"Secret key for MinIO, used for securing access to MinIO object storage."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_POSTGRES_PASSWORD"})}),(0,t.jsx)(n.td,{children:"Password for the PostgreSQL database, used for database authentication and security."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"CADDY_TALAWA_API_DOMAIN_NAME"})}),(0,t.jsx)(n.td,{children:"Domain name for the Talawa API, used for configuring and routing API traffic."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"CADDY_TALAWA_API_EMAIL"})}),(0,t.jsx)(n.td,{children:"Email address for the Talawa API, used for SSL certificate registration and notifications."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"MINIO_ROOT_PASSWORD"})}),(0,t.jsx)(n.td,{children:"Root password for MinIO, used for securing administrative access to MinIO object storage."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"POSTGRES_PASSWORD"})}),(0,t.jsx)(n.td,{children:"Password for the PostgreSQL database (Docker Compose), used for database authentication and security."})]})]})]}),"\n",(0,t.jsx)(n.h2,{id:"prerequisities",children:"Prerequisities"}),"\n",(0,t.jsx)(n.p,{children:"You must follow these steps before continuing."}),"\n",(0,t.jsx)(n.h4,{id:"install-docker",children:"Install Docker"}),"\n",(0,t.jsx)(n.p,{children:"Docker is used to build, deploy, and manage applications within isolated, lightweight containers, effectively packaging an application with all its dependencies so it can run consistently across different environments, allowing for faster development, testing, and deployment of software."}),"\n",(0,t.jsx)(n.p,{children:"We use Docker to simplify installation. Follow these steps to install Docker on your system"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.docker.com/products/docker-desktop",children:"Docker Desktop for Windows/Mac"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://docs.docker.com/engine/install/",children:"Docker Engine for Linux"})}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"After docker is installed, you'll need to verify its operation"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Open a terminal window."}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Run the following commands to check if the required software is installed:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"docker --version"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"docker-compose --version"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Check if docker is running:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"docker info"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsxs)(n.em,{children:["(Note: Restart the docker if you are getting this error ",(0,t.jsx)(n.code,{children:"Cannot connect to the Docker daemon "}),")"]})}),"\n",(0,t.jsxs)(n.h4,{id:"download-the-talawa-api-code",children:["Download the ",(0,t.jsx)(n.code,{children:"talawa-api"})," Code"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"On your computer, navigate to the folder where you want to set up the repository."}),"\n",(0,t.jsxs)(n.li,{children:["Open a command prompt (",(0,t.jsx)(n.code,{children:"cmd"})," for Windows) or terminal (",(0,t.jsx)(n.code,{children:"terminal"})," for Linux or MacOS) session in this folder.","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"You can usually do this by right-clicking in the folder and selecting the appropriate option for your OS."}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Clone the repository to your local computer:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/PalisadoesFoundation/talawa-api.git\ncd talawa-api\ngit checkout develop-postgres\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"production-environment-setup",children:"Production Environment Setup"}),"\n",(0,t.jsx)(n.p,{children:"This section outlines how to setup Talawa-API for use by organizations."}),"\n",(0,t.jsxs)(n.p,{children:["If you are a developer, please go to the ",(0,t.jsx)(n.code,{children:"Development Environment Setup"})," section"]}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsx)(n.p,{children:"You must have basic competence and experience in the following technologies to be able to set up the production environment of talawa api:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Git"}),"\n",(0,t.jsx)(n.li,{children:"Github"}),"\n",(0,t.jsx)(n.li,{children:"Docker"}),"\n",(0,t.jsx)(n.li,{children:"Docker compose"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Please make sure that you have insalled the required software before starting the production environment setup."}),"\n",(0,t.jsx)(n.h3,{id:"setup---instructional-video",children:"Setup - Instructional Video"}),"\n",(0,t.jsx)(n.p,{children:"We provide a mostly automated way of setting up the production environment for the Talawa API using Git, Docker, and Docker-compose. Follow the instructions below and refer to the provided instructional video for a visual guide."}),"\n",(0,t.jsx)(n.p,{children:"Click on the image below to play the video."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://www.youtube.com/watch?v=10Zi2srGPHM",children:(0,t.jsx)(n.img,{src:"https://img.youtube.com/vi/10Zi2srGPHM/0.jpg",alt:"Talawa API Environment Setup - Production"})})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Note: The video contains some inaccuracies."})}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Please ensure you clone from the correct repository ",(0,t.jsx)(n.a,{href:"https://github.com/PalisadoesFoundation/talawa-api",children:"Talawa API Repository"})]}),"\n",(0,t.jsxs)(n.li,{children:["The correct branch to checkout is ",(0,t.jsx)(n.code,{children:"develop-postgres"})]}),"\n",(0,t.jsxs)(n.li,{children:["All the field for .env files are not shown in the video. Refer ",(0,t.jsx)(n.a,{href:"##step-4-configuring-environment-variables",children:"Step 4: Configuring Environment Variables"})]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"setup---all-steps",children:"Setup - All Steps"}),"\n",(0,t.jsx)(n.p,{children:"Follow these steps to have the best experience"}),"\n",(0,t.jsxs)(n.h4,{id:"configure-the-env-file",children:["Configure the ",(0,t.jsx)(n.code,{children:".env"})," File"]}),"\n",(0,t.jsxs)(n.p,{children:["You'll need to create a ",(0,t.jsx)(n.code,{children:".env"})," file in the repository's root directory."]}),"\n",(0,t.jsxs)(n.p,{children:["Copy the content of ",(0,t.jsx)(n.code,{children:"./envFiles/.env.production"})," to the ",(0,t.jsx)(n.code,{children:".env"})," file."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cp ./envFiles/.env.production ./.env\n"})}),"\n",(0,t.jsx)(n.h5,{id:"add-a-jwt-secret-to-env",children:"Add a JWT Secret to .env"}),"\n",(0,t.jsxs)(n.p,{children:["You will need to add a JWT secret to the ",(0,t.jsx)(n.code,{children:".env"})," file"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Open your web browser and go to ",(0,t.jsx)(n.a,{href:"https://jwtsecret.com/generate",children:"https://jwtsecret.com/generate"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Select ",(0,t.jsx)(n.code,{children:"64"})," from the slider."]}),"\n",(0,t.jsxs)(n.li,{children:["Click the ",(0,t.jsx)(n.strong,{children:"Generate"})," button."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Your new 64-character JWT secret will be displayed on the screen."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Copy this secret"}),"\n",(0,t.jsxs)(n.li,{children:["Add it to the ",(0,t.jsx)(n.code,{children:"API_JWT_SECRET"})," value in the ",(0,t.jsx)(n.code,{children:".env"})," file."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"start-the-app",children:"Start the App"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Start the server by running the following command:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"docker compose up\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["To stop the Docker Server, use this command:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"docker compose down\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Congratulations! \ud83c\udf89 Your Talawa API is now successfully set up and running using Docker!"}),"\n",(0,t.jsx)(n.h2,{id:"development-environment-setup",children:"Development Environment Setup"}),"\n",(0,t.jsx)(n.p,{children:"This section outlines how to setup Talawa-API for use by developers wanting to contribute code to the project."}),"\n",(0,t.jsxs)(n.p,{children:["If you want to install it for your organization, then please go to the ",(0,t.jsx)(n.code,{children:"Production Environment Setup"})," section"]}),"\n",(0,t.jsx)(n.h3,{id:"our-recommendations",children:"Our Recommendations"}),"\n",(0,t.jsx)(n.p,{children:"Linux based distributions are simply the best platform for a very vast majority of use cases related to software development. As such we recommend using popular linux based distributions like fedora, arch, ubuntu, linux mint, debian etc., for having a better experience during software development."}),"\n",(0,t.jsx)(n.p,{children:"We make heavy use of Docker containers in our workflows. Since containers are a Linux-based technology, on non-Linux platforms they require Linux emulation through virtual machines, which can impact performance. So, you should be aware that there are performance penalties and certain limitations with running containers on platforms like macOS and windows."}),"\n",(0,t.jsx)(n.p,{children:"Though, many of these penalties and limitations don't apply to windows subsystem for linux. So, if you plan on using windows, at the very least make use of windows subsystem for linux."}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites-1",children:"Prerequisites"}),"\n",(0,t.jsx)(n.p,{children:"You must have basic competence and experience in the following technologies to be able to set up and work within the development environment of talawa api:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Unix based operating systems like linux based distributions, macOS or windows subsystem for linux."}),"\n",(0,t.jsx)(n.li,{children:"Git"}),"\n",(0,t.jsx)(n.li,{children:"Github"}),"\n",(0,t.jsx)(n.li,{children:"Docker"}),"\n",(0,t.jsx)(n.li,{children:"Docker compose"}),"\n",(0,t.jsx)(n.li,{children:"Visual studio code with devcontainers"}),"\n",(0,t.jsx)(n.li,{children:"Typescript"}),"\n",(0,t.jsx)(n.li,{children:"Node.js"}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["It is very important that you go through ",(0,t.jsx)(n.a,{href:"https://code.visualstudio.com/docs/devcontainers/containers",children:"this"})," official documentation for working with devcontainers in visual studio code."]}),"\n",(0,t.jsx)(n.h3,{id:"setup-instructional-video",children:"Setup: Instructional Video"}),"\n",(0,t.jsx)(n.p,{children:"We provide a mostly automated way of setting up the development environment for the Talawa API using Git, Docker, and Visual Studio Code. Follow the instructions below and refer to the provided instructional video for a visual guide."}),"\n",(0,t.jsx)(n.p,{children:"Click on the image below to play the video."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://www.youtube.com/watch?v=jz7koJIXqtk",children:(0,t.jsx)(n.img,{src:"https://img.youtube.com/vi/jz7koJIXqtk/0.jpg",alt:"Talawa API Environment Setup - Development"})})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Note: The video contains some inaccuracies."})}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Please ensure you clone from the correct repository ",(0,t.jsx)(n.a,{href:"https://github.com/PalisadoesFoundation/talawa-api",children:"Talawa API Repository"})]}),"\n",(0,t.jsxs)(n.li,{children:["The correct branch to checkout is ",(0,t.jsx)(n.code,{children:"develop-postgres"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"postgres-test"})," is the name of the test database in the docker-compose file."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"setup-using-the-cli",children:"Setup: Using the CLI"}),"\n",(0,t.jsx)(n.p,{children:"These steps are specific to Linux. You will need to modify them accordingly for other operating systems"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Install ",(0,t.jsx)(n.code,{children:"docker"})," and ensure that the daemon is running."]}),"\n",(0,t.jsx)(n.li,{children:"This process does not require the installation of PostgresSQL. If you have installed postgres on your system, make sure that it is not running."}),"\n",(0,t.jsxs)(n.li,{children:["Windows Only","\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Make sure you clone the ",(0,t.jsx)(n.code,{children:"talawa-api"})," repository to a ",(0,t.jsx)(n.code,{children:"WSL"})," subdirectory."]}),"\n",(0,t.jsx)(n.li,{children:"Run all the following commands from the repository root in that subdirectory."}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Create the ",(0,t.jsx)(n.code,{children:".env"})," file by copying the template from the ",(0,t.jsx)(n.code,{children:"envFiles/"})," directory.","\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"DO NOT EDIT EITHER FILE!"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cp envFiles/.env.devcontainer .env\n"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Install ",(0,t.jsx)(n.code,{children:"pnpm"})," using ",(0,t.jsx)(n.code,{children:"codepack"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"corepack install -g pnpm\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Linux / MacOS Only","\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Setup ",(0,t.jsx)(n.code,{children:"pnpm"})," to be automatically configured on all future terminal session logins using your ",(0,t.jsx)(n.code,{children:"~/.bashrc"})," file.","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm setup\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Enable ",(0,t.jsx)(n.code,{children:"pnpm"})," for your current terminal session.","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"source ~/.bashrc\n"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Install the ",(0,t.jsx)(n.code,{children:"pnpm"})," packages","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm install\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Install the ",(0,t.jsx)(n.code,{children:"devcontainers/cli"})," package","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"pnpm install -g @devcontainers/cli\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["You will now need to make your user a part of the ",(0,t.jsx)(n.code,{children:"docker"})," operating system group or else you will get ",(0,t.jsx)(n.code,{children:"permission denied"})," messages when starting docker later. ",(0,t.jsx)(n.code,{children:"$USER"})," is a universal representation of your username. You don't need to change this in the command below.","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"sudo usermod -a -G docker $USER\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["You will only become a part of the ",(0,t.jsx)(n.code,{children:"docker"})," group on your next login. You don't have to logout, just start another session on the CLI using the ",(0,t.jsx)(n.code,{children:"su"})," command.","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"sudo su $USER -\n"})}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:"Build the docker devcontainer"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"devcontainer build --workspace-folder .\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"10",children:["\n",(0,t.jsx)(n.li,{children:"When the build is complete, the last line of the output should be:"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{"outcome":"success","imageName":"talawa-api"}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"11",children:["\n",(0,t.jsx)(n.li,{children:"Start the docker devcontainer"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"devcontainer up --workspace-folder .\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"12",children:["\n",(0,t.jsx)(n.li,{children:"When the startup is complete, the last line of out put should look like this:"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"...\n...\n...\n[19:53:14.113] INFO (166): Server listening at http://127.0.0.1:4000\n[19:53:14.113] INFO (166): Server listening at http://172.23.0.3:4000\n[19:53:14.113] INFO (166): Server listening at http://172.20.0.2:4000\n[19:53:14.113] INFO (166): Server listening at http://172.19.0.3:4000\n[19:53:14.113] INFO (166): Server listening at http://172.21.0.3:4000\n[19:53:14.113] INFO (166): Server listening at http://172.22.0.4:4000\n"})}),"\n",(0,t.jsx)(n.p,{children:"All done!"}),"\n",(0,t.jsx)(n.h4,{id:"cli-shutdown-development",children:"CLI Shutdown (Development)"}),"\n",(0,t.jsxs)(n.p,{children:["Use the command ",(0,t.jsx)(n.code,{children:"docker compose"})," command to cleanly shutdown the dev container"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"docker compose down\n"})}),"\n",(0,t.jsx)(n.h4,{id:"cli-startup-development",children:"CLI Startup (Development)"}),"\n",(0,t.jsx)(n.p,{children:"After a successful installation, use these commands in sequence to start the dev container."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"devcontainer build --workspace-folder .\ndevcontainer up --workspace-folder .\n"})}),"\n",(0,t.jsx)(n.h4,{id:"import-sample-data",children:"Import Sample Data"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Once the server is running, open a new terminal session."}),"\n",(0,t.jsxs)(n.li,{children:["Open a bash session inside the running container:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"docker exec -it talawa-api-1 /bin/bash\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Inside the container, run the following command to import sample data into the database:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" pnpm run import:sample-data\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Then exit","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" exit\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"setup-using-the-vscode-ide",children:"Setup: Using the VScode IDE"}),"\n",(0,t.jsx)(n.p,{children:"You can setup the app using the VScode IDE. Here are the steps to follow:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Open cloned talawa-api project in Visual Studio Code."}),"\n",(0,t.jsxs)(n.li,{children:["Install the ",(0,t.jsx)(n.code,{children:"devcontainer"})," extension in VScode."]}),"\n",(0,t.jsxs)(n.li,{children:["You should see a notification that a ",(0,t.jsx)(n.code,{children:"devcontainer"})," configuration file is available. Click on the notification and select ",(0,t.jsx)(n.code,{children:"Reopen in Container"}),".","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["If you don't see the notification, you can open the command palette by pressing ",(0,t.jsx)(n.code,{children:"Ctrl+Shift+P"})," and search for ",(0,t.jsx)(n.code,{children:"Reopen in Container"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Make sure you have downloaded ",(0,t.jsx)(n.code,{children:"devcontainer"})," extension of vs code."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:"This will open a new Visual Studio Code window with the project running inside a Docker container. This will take a few minutes to complete."}),"\n",(0,t.jsx)(n.li,{children:"Wait till the process is complete and you see ports being forwarded in the terminal."}),"\n",(0,t.jsxs)(n.li,{children:["You can check logs by clicking ",(0,t.jsx)(n.code,{children:"Connecting to Dev Container (show log)"}),";"]}),"\n",(0,t.jsxs)(n.li,{children:["Create a new terminal in Visual Studio Code by pressing ",(0,t.jsx)(n.code,{children:"Ctrl+Shift+` "}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Run the ",(0,t.jsx)(n.code,{children:"pwd"})," command to confirm you are in the ",(0,t.jsx)(n.code,{children:"/home/talawa/api"})," directory."]}),"\n",(0,t.jsxs)(n.li,{children:["Run the following command to check if the project has required dependencies installed correctly:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" node -v\n pnpm -v\n"})}),"\n","Congratulations! \ud83c\udf89 Your Talawa API is now successfully set up and running using Docker and Vs code!"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"development-mode-operation",children:"Development Mode Operation"}),"\n",(0,t.jsx)(n.p,{children:"You can run the app after closing the terminal or restating the vscode using these commands:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"for normal mode"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" pnpm run start_development_server\n"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"for debugging mode"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" pnpm run start_development_server_with_debugger\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," These commands will start the server in development mode."]}),"\n",(0,t.jsx)(n.h2,{id:"testing-and-validation",children:"Testing and Validation"}),"\n",(0,t.jsxs)(n.p,{children:["Please refer to the ",(0,t.jsx)(n.a,{href:"/docs/developer-resources/testing",children:"Testing and Validation Page"})," for more details"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},60385:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>l});var s=i(30758);const t={},o=s.createContext(t);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/1b7c35d8.e59be5a2.js b/assets/js/1b7c35d8.e59be5a2.js
new file mode 100644
index 0000000000..b0499cb21f
--- /dev/null
+++ b/assets/js/1b7c35d8.e59be5a2.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4268],{89795:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"docs/getting-started/installation","title":"Installation","description":"This document provides instructions on how to set up and start a running instance of talawa-api on your local system. The instructions are written to be followed in sequence so make sure to go through each of them step by step without skipping any sections.","source":"@site/docs/docs/getting-started/installation.md","sourceDirName":"docs/getting-started","slug":"/installation","permalink":"/docs/installation","draft":false,"unlisted":false,"editUrl":"https://github.com/PalisadoesFoundation/talawa-api/edit/develop/docs/docs/docs/getting-started/installation.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"installation","title":"Installation","slug":"/installation","sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Introduction","permalink":"/docs/"},"next":{"title":"Environment Variables","permalink":"/docs/installation/environment-variables"}}');var t=i(86070),r=i(60385);const o={id:"installation",title:"Installation",slug:"/installation",sidebar_position:1},l=void 0,d={},c=[{value:"The .env Configuration File",id:"the-env-configuration-file",level:2},{value:"Prerequisities",id:"prerequisities",level:2},{value:"Install Docker",id:"install-docker",level:4},{value:"Download the talawa-api Code",id:"download-the-talawa-api-code",level:4},{value:"Production Environment Setup",id:"production-environment-setup",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Setup - Instructional Video",id:"setup---instructional-video",level:3},{value:"Setup - All Steps",id:"setup---all-steps",level:3},{value:"Configure the .env File",id:"configure-the-env-file",level:4},{value:"Add a JWT Secret to .env",id:"add-a-jwt-secret-to-env",level:5},{value:"Start the App",id:"start-the-app",level:4},{value:"Development Environment Setup",id:"development-environment-setup",level:2},{value:"Our Recommendations",id:"our-recommendations",level:3},{value:"Prerequisites",id:"prerequisites-1",level:3},{value:"Setup: Instructional Video",id:"setup-instructional-video",level:3},{value:"Setup: Using the CLI",id:"setup-using-the-cli",level:3},{value:"CLI Shutdown (Development)",id:"cli-shutdown-development",level:4},{value:"CLI Startup (Development)",id:"cli-startup-development",level:4},{value:"Import Sample Data",id:"import-sample-data",level:4},{value:"Setup: Using the VScode IDE",id:"setup-using-the-vscode-ide",level:3},{value:"Development Mode Operation",id:"development-mode-operation",level:4},{value:"Sample Users",id:"sample-users",level:2},{value:"Testing and Validation",id:"testing-and-validation",level:2}];function a(e){const n={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",h5:"h5",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"This document provides instructions on how to set up and start a running instance of talawa-api on your local system. The instructions are written to be followed in sequence so make sure to go through each of them step by step without skipping any sections."}),"\n",(0,t.jsx)(n.h2,{id:"the-env-configuration-file",children:"The .env Configuration File"}),"\n",(0,t.jsx)(n.p,{children:"You will need to configure the API to work correctly."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["The configuration file is called ",(0,t.jsx)(n.code,{children:".env"})," and must be placed in the root directory of the code."]}),"\n",(0,t.jsxs)(n.li,{children:["This table defines some the parameters required for smooth operation","\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Steps explaining the usage of the ",(0,t.jsx)(n.code,{children:".env"})," file will be found in subsequent sections"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"NOTE:"})," Visit our ",(0,t.jsx)(n.a,{href:"/docs/installation/environment-variables",children:"Environment Variables Page"})," for a comprehensive list of possibilities."]}),"\n"]}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:(0,t.jsx)(n.strong,{children:"Variable"})}),(0,t.jsx)(n.th,{children:(0,t.jsx)(n.strong,{children:"Use Case"})})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_ADMINISTRATOR_USER_EMAIL_ADDRESS"})}),(0,t.jsx)(n.td,{children:"Email address of the administrator user."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_ADMINISTRATOR_USER_NAME"})}),(0,t.jsx)(n.td,{children:"Username of the administrator user, used for admin login and identification."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_ADMINISTRATOR_USER_PASSWORD"})}),(0,t.jsx)(n.td,{children:"Password for the administrator user, used for admin login security."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_BASE_URL"})}),(0,t.jsx)(n.td,{children:"Base URL for the API, used for constructing API endpoints and routing requests."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_FACEBOOK_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's Facebook page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_GITHUB_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's GitHub repository, used for linking and integrating code repository."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_INSTAGRAM_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's Instagram page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_LINKEDIN_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's LinkedIn page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_NAME"})}),(0,t.jsx)(n.td,{children:"Name of the community, used for branding and identification within the application."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_REDDIT_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's Reddit page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_SLACK_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's Slack workspace, used for linking and integrating communication channels."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_WEBSITE_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's website, used for linking and integrating online presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_X_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's X (formerly Twitter) page, used for linking and integrating social media presence."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_COMMUNITY_YOUTUBE_URL"})}),(0,t.jsx)(n.td,{children:"URL to the community's YouTube channel, used for linking and integrating video content."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_JWT_SECRET"})}),(0,t.jsx)(n.td,{children:"Secret key for JWT(JSON Web Token) generation and validation, used for securing API authentication and authorization."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_MINIO_SECRET_KEY"})}),(0,t.jsx)(n.td,{children:"Secret key for MinIO, used for securing access to MinIO object storage."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"API_POSTGRES_PASSWORD"})}),(0,t.jsx)(n.td,{children:"Password for the PostgreSQL database, used for database authentication and security."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"CADDY_TALAWA_API_DOMAIN_NAME"})}),(0,t.jsx)(n.td,{children:"Domain name for the Talawa API, used for configuring and routing API traffic."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"CADDY_TALAWA_API_EMAIL"})}),(0,t.jsx)(n.td,{children:"Email address for the Talawa API, used for SSL certificate registration and notifications."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"MINIO_ROOT_PASSWORD"})}),(0,t.jsx)(n.td,{children:"Root password for MinIO, used for securing administrative access to MinIO object storage."})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:(0,t.jsx)(n.code,{children:"POSTGRES_PASSWORD"})}),(0,t.jsx)(n.td,{children:"Password for the PostgreSQL database (Docker Compose), used for database authentication and security."})]})]})]}),"\n",(0,t.jsx)(n.h2,{id:"prerequisities",children:"Prerequisities"}),"\n",(0,t.jsx)(n.p,{children:"You must follow these steps before continuing."}),"\n",(0,t.jsx)(n.h4,{id:"install-docker",children:"Install Docker"}),"\n",(0,t.jsx)(n.p,{children:"Docker is used to build, deploy, and manage applications within isolated, lightweight containers, effectively packaging an application with all its dependencies so it can run consistently across different environments, allowing for faster development, testing, and deployment of software."}),"\n",(0,t.jsx)(n.p,{children:"We use Docker to simplify installation. Follow these steps to install Docker on your system"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://www.docker.com/products/docker-desktop",children:"Docker Desktop for Windows/Mac"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://docs.docker.com/engine/install/",children:"Docker Engine for Linux"})}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"After docker is installed, you'll need to verify its operation"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Open a terminal window."}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Run the following commands to check if the required software is installed:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"docker --version"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"docker-compose --version"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Check if docker is running:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.code,{children:"docker info"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsxs)(n.em,{children:["(Note: Restart the docker if you are getting this error ",(0,t.jsx)(n.code,{children:"Cannot connect to the Docker daemon "}),")"]})}),"\n",(0,t.jsxs)(n.h4,{id:"download-the-talawa-api-code",children:["Download the ",(0,t.jsx)(n.code,{children:"talawa-api"})," Code"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"On your computer, navigate to the folder where you want to set up the repository."}),"\n",(0,t.jsxs)(n.li,{children:["Open a command prompt (",(0,t.jsx)(n.code,{children:"cmd"})," for Windows) or terminal (",(0,t.jsx)(n.code,{children:"terminal"})," for Linux or MacOS) session in this folder.","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"You can usually do this by right-clicking in the folder and selecting the appropriate option for your OS."}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Clone the repository to your local computer:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/PalisadoesFoundation/talawa-api.git\ncd talawa-api\ngit checkout develop-postgres\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"production-environment-setup",children:"Production Environment Setup"}),"\n",(0,t.jsx)(n.p,{children:"This section outlines how to setup Talawa-API for use by organizations."}),"\n",(0,t.jsxs)(n.p,{children:["If you are a developer, please go to the ",(0,t.jsx)(n.code,{children:"Development Environment Setup"})," section"]}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsx)(n.p,{children:"You must have basic competence and experience in the following technologies to be able to set up the production environment of talawa api:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Git"}),"\n",(0,t.jsx)(n.li,{children:"Github"}),"\n",(0,t.jsx)(n.li,{children:"Docker"}),"\n",(0,t.jsx)(n.li,{children:"Docker compose"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Please make sure that you have insalled the required software before starting the production environment setup."}),"\n",(0,t.jsx)(n.h3,{id:"setup---instructional-video",children:"Setup - Instructional Video"}),"\n",(0,t.jsx)(n.p,{children:"We provide a mostly automated way of setting up the production environment for the Talawa API using Git, Docker, and Docker-compose. Follow the instructions below and refer to the provided instructional video for a visual guide."}),"\n",(0,t.jsx)(n.p,{children:"Click on the image below to play the video."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://www.youtube.com/watch?v=10Zi2srGPHM",children:(0,t.jsx)(n.img,{src:"https://img.youtube.com/vi/10Zi2srGPHM/0.jpg",alt:"Talawa API Environment Setup - Production"})})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Note: The video contains some inaccuracies."})}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Please ensure you clone from the correct repository ",(0,t.jsx)(n.a,{href:"https://github.com/PalisadoesFoundation/talawa-api",children:"Talawa API Repository"})]}),"\n",(0,t.jsxs)(n.li,{children:["The correct branch to checkout is ",(0,t.jsx)(n.code,{children:"develop-postgres"})]}),"\n",(0,t.jsxs)(n.li,{children:["All the field for .env files are not shown in the video. Refer ",(0,t.jsx)(n.a,{href:"##step-4-configuring-environment-variables",children:"Step 4: Configuring Environment Variables"})]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"setup---all-steps",children:"Setup - All Steps"}),"\n",(0,t.jsx)(n.p,{children:"Follow these steps to have the best experience"}),"\n",(0,t.jsxs)(n.h4,{id:"configure-the-env-file",children:["Configure the ",(0,t.jsx)(n.code,{children:".env"})," File"]}),"\n",(0,t.jsxs)(n.p,{children:["You'll need to create a ",(0,t.jsx)(n.code,{children:".env"})," file in the repository's root directory."]}),"\n",(0,t.jsxs)(n.p,{children:["Copy the content of ",(0,t.jsx)(n.code,{children:"./envFiles/.env.production"})," to the ",(0,t.jsx)(n.code,{children:".env"})," file."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cp ./envFiles/.env.production ./.env\n"})}),"\n",(0,t.jsx)(n.h5,{id:"add-a-jwt-secret-to-env",children:"Add a JWT Secret to .env"}),"\n",(0,t.jsxs)(n.p,{children:["You will need to add a JWT secret to the ",(0,t.jsx)(n.code,{children:".env"})," file"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Open your web browser and go to ",(0,t.jsx)(n.a,{href:"https://jwtsecret.com/generate",children:"https://jwtsecret.com/generate"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Select ",(0,t.jsx)(n.code,{children:"64"})," from the slider."]}),"\n",(0,t.jsxs)(n.li,{children:["Click the ",(0,t.jsx)(n.strong,{children:"Generate"})," button."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Your new 64-character JWT secret will be displayed on the screen."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Copy this secret"}),"\n",(0,t.jsxs)(n.li,{children:["Add it to the ",(0,t.jsx)(n.code,{children:"API_JWT_SECRET"})," value in the ",(0,t.jsx)(n.code,{children:".env"})," file."]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"start-the-app",children:"Start the App"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Start the server by running the following command:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"docker compose up\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["To stop the Docker Server, use this command:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"docker compose down\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Congratulations! \ud83c\udf89 Your Talawa API is now successfully set up and running using Docker!"}),"\n",(0,t.jsx)(n.h2,{id:"development-environment-setup",children:"Development Environment Setup"}),"\n",(0,t.jsx)(n.p,{children:"This section outlines how to setup Talawa-API for use by developers wanting to contribute code to the project."}),"\n",(0,t.jsxs)(n.p,{children:["If you want to install it for your organization, then please go to the ",(0,t.jsx)(n.code,{children:"Production Environment Setup"})," section"]}),"\n",(0,t.jsx)(n.h3,{id:"our-recommendations",children:"Our Recommendations"}),"\n",(0,t.jsx)(n.p,{children:"Linux based distributions are simply the best platform for a very vast majority of use cases related to software development. As such we recommend using popular linux based distributions like fedora, arch, ubuntu, linux mint, debian etc., for having a better experience during software development."}),"\n",(0,t.jsx)(n.p,{children:"We make heavy use of Docker containers in our workflows. Since containers are a Linux-based technology, on non-Linux platforms they require Linux emulation through virtual machines, which can impact performance. So, you should be aware that there are performance penalties and certain limitations with running containers on platforms like macOS and windows."}),"\n",(0,t.jsx)(n.p,{children:"Though, many of these penalties and limitations don't apply to windows subsystem for linux. So, if you plan on using windows, at the very least make use of windows subsystem for linux."}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites-1",children:"Prerequisites"}),"\n",(0,t.jsx)(n.p,{children:"You must have basic competence and experience in the following technologies to be able to set up and work within the development environment of talawa api:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Unix based operating systems like linux based distributions, macOS or windows subsystem for linux."}),"\n",(0,t.jsx)(n.li,{children:"Git"}),"\n",(0,t.jsx)(n.li,{children:"Github"}),"\n",(0,t.jsx)(n.li,{children:"Docker"}),"\n",(0,t.jsx)(n.li,{children:"Docker compose"}),"\n",(0,t.jsx)(n.li,{children:"Visual studio code with devcontainers"}),"\n",(0,t.jsx)(n.li,{children:"Typescript"}),"\n",(0,t.jsx)(n.li,{children:"Node.js"}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["It is very important that you go through ",(0,t.jsx)(n.a,{href:"https://code.visualstudio.com/docs/devcontainers/containers",children:"this"})," official documentation for working with devcontainers in visual studio code."]}),"\n",(0,t.jsx)(n.h3,{id:"setup-instructional-video",children:"Setup: Instructional Video"}),"\n",(0,t.jsx)(n.p,{children:"We provide a mostly automated way of setting up the development environment for the Talawa API using Git, Docker, and Visual Studio Code. Follow the instructions below and refer to the provided instructional video for a visual guide."}),"\n",(0,t.jsx)(n.p,{children:"Click on the image below to play the video."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://www.youtube.com/watch?v=jz7koJIXqtk",children:(0,t.jsx)(n.img,{src:"https://img.youtube.com/vi/jz7koJIXqtk/0.jpg",alt:"Talawa API Environment Setup - Development"})})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Note: The video contains some inaccuracies."})}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Please ensure you clone from the correct repository ",(0,t.jsx)(n.a,{href:"https://github.com/PalisadoesFoundation/talawa-api",children:"Talawa API Repository"})]}),"\n",(0,t.jsxs)(n.li,{children:["The correct branch to checkout is ",(0,t.jsx)(n.code,{children:"develop-postgres"})]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"postgres-test"})," is the name of the test database in the docker-compose file."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"setup-using-the-cli",children:"Setup: Using the CLI"}),"\n",(0,t.jsx)(n.p,{children:"These steps are specific to Linux. You will need to modify them accordingly for other operating systems"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Install ",(0,t.jsx)(n.code,{children:"docker"})," and ensure that the daemon is running."]}),"\n",(0,t.jsx)(n.li,{children:"This process does not require the installation of PostgresSQL. If you have installed postgres on your system, make sure that it is not running."}),"\n",(0,t.jsxs)(n.li,{children:["Windows Only","\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Make sure you clone the ",(0,t.jsx)(n.code,{children:"talawa-api"})," repository to a ",(0,t.jsx)(n.code,{children:"WSL"})," subdirectory."]}),"\n",(0,t.jsx)(n.li,{children:"Run all the following commands from the repository root in that subdirectory."}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Create the ",(0,t.jsx)(n.code,{children:".env"})," file by copying the template from the ",(0,t.jsx)(n.code,{children:"envFiles/"})," directory.","\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"DO NOT EDIT EITHER FILE!"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cp envFiles/.env.devcontainer .env\n"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Install ",(0,t.jsx)(n.code,{children:"pnpm"})," using ",(0,t.jsx)(n.code,{children:"codepack"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"corepack install -g pnpm\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Linux / MacOS Only","\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Setup ",(0,t.jsx)(n.code,{children:"pnpm"})," to be automatically configured on all future terminal session logins using your ",(0,t.jsx)(n.code,{children:"~/.bashrc"})," file.","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm setup\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Enable ",(0,t.jsx)(n.code,{children:"pnpm"})," for your current terminal session.","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"source ~/.bashrc\n"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Install the ",(0,t.jsx)(n.code,{children:"pnpm"})," packages","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm install\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Install the ",(0,t.jsx)(n.code,{children:"devcontainers/cli"})," package","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"pnpm install -g @devcontainers/cli\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["You will now need to make your user a part of the ",(0,t.jsx)(n.code,{children:"docker"})," operating system group or else you will get ",(0,t.jsx)(n.code,{children:"permission denied"})," messages when starting docker later. ",(0,t.jsx)(n.code,{children:"$USER"})," is a universal representation of your username. You don't need to change this in the command below.","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"sudo usermod -a -G docker $USER\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["You will only become a part of the ",(0,t.jsx)(n.code,{children:"docker"})," group on your next login. You don't have to logout, just start another session on the CLI using the ",(0,t.jsx)(n.code,{children:"su"})," command.","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"sudo su $USER -\n"})}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:"Build the docker devcontainer"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"devcontainer build --workspace-folder .\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"10",children:["\n",(0,t.jsx)(n.li,{children:"When the build is complete, the last line of the output should be:"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'{"outcome":"success","imageName":"talawa-api"}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"11",children:["\n",(0,t.jsx)(n.li,{children:"Start the docker devcontainer"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"devcontainer up --workspace-folder .\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"12",children:["\n",(0,t.jsx)(n.li,{children:"When the startup is complete, the last line of out put should look like this:"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"...\n...\n...\n[19:53:14.113] INFO (166): Server listening at http://127.0.0.1:4000\n[19:53:14.113] INFO (166): Server listening at http://172.23.0.3:4000\n[19:53:14.113] INFO (166): Server listening at http://172.20.0.2:4000\n[19:53:14.113] INFO (166): Server listening at http://172.19.0.3:4000\n[19:53:14.113] INFO (166): Server listening at http://172.21.0.3:4000\n[19:53:14.113] INFO (166): Server listening at http://172.22.0.4:4000\n"})}),"\n",(0,t.jsx)(n.p,{children:"All done!"}),"\n",(0,t.jsx)(n.h4,{id:"cli-shutdown-development",children:"CLI Shutdown (Development)"}),"\n",(0,t.jsxs)(n.p,{children:["Use the command ",(0,t.jsx)(n.code,{children:"docker compose"})," command to cleanly shutdown the dev container"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"docker compose down\n"})}),"\n",(0,t.jsx)(n.h4,{id:"cli-startup-development",children:"CLI Startup (Development)"}),"\n",(0,t.jsx)(n.p,{children:"After a successful installation, use these commands in sequence to start the dev container."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"devcontainer build --workspace-folder .\ndevcontainer up --workspace-folder .\n"})}),"\n",(0,t.jsx)(n.h4,{id:"import-sample-data",children:"Import Sample Data"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Once the server is running, open a new terminal session."}),"\n",(0,t.jsxs)(n.li,{children:["Open a bash session inside the running container:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"docker exec -it talawa-api-1 /bin/bash\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Inside the container, run the following command to import sample data into the database:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" pnpm run import:sample-data\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["Then exit","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" exit\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"setup-using-the-vscode-ide",children:"Setup: Using the VScode IDE"}),"\n",(0,t.jsx)(n.p,{children:"You can setup the app using the VScode IDE. Here are the steps to follow:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Open cloned talawa-api project in Visual Studio Code."}),"\n",(0,t.jsxs)(n.li,{children:["Install the ",(0,t.jsx)(n.code,{children:"devcontainer"})," extension in VScode."]}),"\n",(0,t.jsxs)(n.li,{children:["You should see a notification that a ",(0,t.jsx)(n.code,{children:"devcontainer"})," configuration file is available. Click on the notification and select ",(0,t.jsx)(n.code,{children:"Reopen in Container"}),".","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["If you don't see the notification, you can open the command palette by pressing ",(0,t.jsx)(n.code,{children:"Ctrl+Shift+P"})," and search for ",(0,t.jsx)(n.code,{children:"Reopen in Container"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Make sure you have downloaded ",(0,t.jsx)(n.code,{children:"devcontainer"})," extension of vs code."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.li,{children:"This will open a new Visual Studio Code window with the project running inside a Docker container. This will take a few minutes to complete."}),"\n",(0,t.jsx)(n.li,{children:"Wait till the process is complete and you see ports being forwarded in the terminal."}),"\n",(0,t.jsxs)(n.li,{children:["You can check logs by clicking ",(0,t.jsx)(n.code,{children:"Connecting to Dev Container (show log)"}),";"]}),"\n",(0,t.jsxs)(n.li,{children:["Create a new terminal in Visual Studio Code by pressing ",(0,t.jsx)(n.code,{children:"Ctrl+Shift+` "}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Run the ",(0,t.jsx)(n.code,{children:"pwd"})," command to confirm you are in the ",(0,t.jsx)(n.code,{children:"/home/talawa/api"})," directory."]}),"\n",(0,t.jsxs)(n.li,{children:["Run the following command to check if the project has required dependencies installed correctly:","\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" node -v\n pnpm -v\n"})}),"\n","Congratulations! \ud83c\udf89 Your Talawa API is now successfully set up and running using Docker and Vs code!"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"development-mode-operation",children:"Development Mode Operation"}),"\n",(0,t.jsx)(n.p,{children:"You can run the app after closing the terminal or restating the vscode using these commands:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"for normal mode"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" pnpm run start_development_server\n"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"for debugging mode"}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:" pnpm run start_development_server_with_debugger\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," These commands will start the server in development mode."]}),"\n",(0,t.jsx)(n.h2,{id:"sample-users",children:"Sample Users"}),"\n",(0,t.jsx)(n.p,{children:"Below is a table of sample user data."}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:(0,t.jsx)(n.strong,{children:"Name"})}),(0,t.jsx)(n.th,{children:(0,t.jsx)(n.strong,{children:"Email Address"})}),(0,t.jsx)(n.th,{children:(0,t.jsx)(n.strong,{children:"Password"})}),(0,t.jsx)(n.th,{children:(0,t.jsx)(n.strong,{children:"Role"})})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Wilt Shepherd"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testsuperadmin@example.com",children:"testsuperadmin@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"administrator"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Vyvyan Kerry"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testadmin1@example.com",children:"testadmin1@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"administrator"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Loyd Solomon"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testadmin2@example.com",children:"testadmin2@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"administrator"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Darcy Wilf"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testadmin3@example.com",children:"testadmin3@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"administrator"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Harve Lance"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser1@example.com",children:"testuser1@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Praise Norris"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser2@example.com",children:"testuser2@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Scott Tony"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser3@example.com",children:"testuser3@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Teresa Bradley"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser4@example.com",children:"testuser4@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Bruce Garza"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser5@example.com",children:"testuser5@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Burton Sanders"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser6@example.com",children:"testuser6@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Jeramy Garcia"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser7@example.com",children:"testuser7@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Deanne Marks"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser8@example.com",children:"testuser8@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Romeo Holland"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser9@example.com",children:"testuser9@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Carla Nguyen"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser10@example.com",children:"testuser10@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"Peggy Bowers"}),(0,t.jsx)(n.td,{children:(0,t.jsx)(n.a,{href:"mailto:testuser11@example.com",children:"testuser11@example.com"})}),(0,t.jsx)(n.td,{children:"Pass@123"}),(0,t.jsx)(n.td,{children:"regular"})]})]})]}),"\n",(0,t.jsx)(n.h2,{id:"testing-and-validation",children:"Testing and Validation"}),"\n",(0,t.jsxs)(n.p,{children:["Please refer to the ",(0,t.jsx)(n.a,{href:"/docs/developer-resources/testing",children:"Testing and Validation Page"})," for more details"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},60385:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>l});var s=i(30758);const t={},r=s.createContext(t);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/runtime~main.b4695c4c.js b/assets/js/runtime~main.5d6c106f.js
similarity index 99%
rename from assets/js/runtime~main.b4695c4c.js
rename to assets/js/runtime~main.5d6c106f.js
index 6fa5a9107b..6d79626b65 100644
--- a/assets/js/runtime~main.b4695c4c.js
+++ b/assets/js/runtime~main.5d6c106f.js
@@ -1 +1 @@
-(()=>{"use strict";var e,a,d,c,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,e=[],r.O=(a,d,c,f)=>{if(!d){var b=1/0;for(i=0;i pnpm run start_development_server_with_debugger
Note: These commands will start the server in development mode.
+Below is a table of sample user data.
+| Name | Email Address | Password | Role |
|---|---|---|---|
| Wilt Shepherd | testsuperadmin@example.com | Pass@123 | administrator |
| Vyvyan Kerry | testadmin1@example.com | Pass@123 | administrator |
| Loyd Solomon | testadmin2@example.com | Pass@123 | administrator |
| Darcy Wilf | testadmin3@example.com | Pass@123 | administrator |
| Harve Lance | testuser1@example.com | Pass@123 | regular |
| Praise Norris | testuser2@example.com | Pass@123 | regular |
| Scott Tony | testuser3@example.com | Pass@123 | regular |
| Teresa Bradley | testuser4@example.com | Pass@123 | regular |
| Bruce Garza | testuser5@example.com | Pass@123 | regular |
| Burton Sanders | testuser6@example.com | Pass@123 | regular |
| Jeramy Garcia | testuser7@example.com | Pass@123 | regular |
| Deanne Marks | testuser8@example.com | Pass@123 | regular |
| Romeo Holland | testuser9@example.com | Pass@123 | regular |
| Carla Nguyen | testuser10@example.com | Pass@123 | regular |
| Peggy Bowers | testuser11@example.com | Pass@123 | regular |
Please refer to the Testing and Validation Page for more details
Please refer to the Testing and Validation Page for more details