From 325ec7de8b2b6490687751a6f764d69bbd0411cf Mon Sep 17 00:00:00 2001 From: Sahitya Chandra Date: Fri, 3 Jan 2025 17:44:20 +0530 Subject: [PATCH] .eslintignore deleted and INSTALLATION.md updated --- .eslintignore | 8 --- .eslintrc.json | 10 ++-- INSTALLATION.md | 79 ++++++++++++++++++++++++++ examples/linux/Daemon_Service_Setup.md | 68 ---------------------- 4 files changed, 85 insertions(+), 80 deletions(-) delete mode 100644 .eslintignore delete mode 100644 examples/linux/Daemon_Service_Setup.md diff --git a/.eslintignore b/.eslintignore deleted file mode 100644 index ee98c5bdb0..0000000000 --- a/.eslintignore +++ /dev/null @@ -1,8 +0,0 @@ -# Contains the PDF file of the Tag as JSON string, thus does not need to be linted -src/components/CheckIn/tagTemplate.ts -package.json -package-lock.json -tsconfig.json - -# Ignore the Docusaurus website subdirectory -docs/** \ No newline at end of file diff --git a/.eslintrc.json b/.eslintrc.json index de93fb465f..242ea4f8dc 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -149,9 +149,11 @@ "**/*.less", "**/*.json", "**/*.svg", - "docs/docusaurus.config.ts", - "docs/sidebars.ts", - "docs/src/**", - "docs/blog/**" + "src/components/CheckIn/tagTemplate.ts", + "package.json", + "package-lock.json", + "tsconfig.json", + "docs/**", + "examples/**" ] } diff --git a/INSTALLATION.md b/INSTALLATION.md index 3c09f69e33..3dc43f88cc 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -16,6 +16,16 @@ This document provides instructions on how to set up and start a running instanc - [Installation using Docker](#installation-using-docker) - [Prerequisites](#prerequisites-1) - [Development Setup](#development-setup) +- [Talawa-Admin Service Setup Guide](#talawa-admin-service-setup-guide) + - [Prerequisites](#prerequisites-2) + - [Service Configuration](#service-configuration) + - [1. **Copy the `talawa_admin.service` file**](#1-copy-the-talawa_adminservice-file) + - [2. **Verify the CODEROOT Path**](#2-verify-the-coderoot-path) + - [3. **Set the Correct Working Directory**](#3-set-the-correct-working-directory) + - [4. **Ensure the `.env` File Exists**](#4-ensure-the-env-file-exists) + - [5. **Adjust User and Group**](#5-adjust-user-and-group) + - [Steps to Enable and Manage the Service](#steps-to-enable-and-manage-the-service) + - [Troubleshooting](#troubleshooting) @@ -380,3 +390,72 @@ If you don't want this hook to run, you can manually opt out of this using the `
``` + +# Talawa-Admin Service Setup Guide + +This guide outlines the steps to set up and manage the Talawa-Admin service on a Linux server using `systemd`. + +### Prerequisites + +- Firstly, You should have locally setup the Talawa-Admin repo using [Setting up this repository](#setting-up-this-repository) +- Ensure **Node.js** and **npm** are correctly installed and available for the specified user and group. +- It’s recommended to use **nvm** (Node Version Manager) for better management of different Node.js versions. + +--- + +### Service Configuration + +#### 1. **Copy the `talawa_admin.service` file** + - Place the `talawa_admin.service` file in the appropriate systemd directory based on your Linux distribution: + - For most distributions: `/etc/systemd/system/` + - For systems using `systemd`, this will be the default directory. + +#### 2. **Verify the CODEROOT Path** + - Ensure that the `CODEROOT` environment variable matches the absolute path to the Talawa-Admin code directory. + +#### 3. **Set the Correct Working Directory** + - Always use the absolute path for the `WorkingDirectory`. Do **not** use `$CODEROOT` in the `WorkingDirectory` field. + +#### 4. **Ensure the `.env` File Exists** + - Verify that the path in the `EnvironmentFile` line points to a valid `.env` file located in the root directory of the Talawa-Admin repository. + +#### 5. **Adjust User and Group** + - Modify the `User` and `Group` settings to match the user account intended to run the service. + +--- + +### Steps to Enable and Manage the Service + +1. **Reload the systemd daemon** to apply changes: + ```bash + sudo systemctl daemon-reload + ``` + +2. **Start the Talawa-Admin Service**: + ```bash + sudo systemctl start talawa_admin.service + ``` + +3. **Stop the Talawa-Admin Service**: + ```bash + sudo systemctl stop talawa_admin.service + ``` + +4. **Enable the Service to Start on Boot**: + ```bash + sudo systemctl enable talawa_admin.service + ``` + +--- + +### Troubleshooting + +- If you encounter any issues, you can check the status and logs of the service: + ```bash + sudo systemctl status talawa_admin.service + sudo journalctl -u talawa_admin.service + ``` + +--- + +By following these steps, you can set up and manage the Talawa-Admin service efficiently on your Linux server. \ No newline at end of file diff --git a/examples/linux/Daemon_Service_Setup.md b/examples/linux/Daemon_Service_Setup.md deleted file mode 100644 index 51344be6b5..0000000000 --- a/examples/linux/Daemon_Service_Setup.md +++ /dev/null @@ -1,68 +0,0 @@ - -# Talawa-Admin Service Setup Guide - -This guide outlines the steps to set up and manage the Talawa-Admin service on a Linux server using `systemd`. - -### Prerequisites - -- Ensure **Node.js** and **npm** are correctly installed and available for the specified user and group. -- It’s recommended to use **nvm** (Node Version Manager) for better management of different Node.js versions. - ---- - -### Service Configuration - -#### 1. **Copy the `talawa_admin.service` file** - - Place the `talawa_admin.service` file in the appropriate systemd directory based on your Linux distribution: - - For most distributions: `/etc/systemd/system/` - - For systems using `systemd`, this will be the default directory. - -#### 2. **Verify the CODEROOT Path** - - Ensure that the `CODEROOT` environment variable matches the absolute path to the Talawa-Admin code directory. - -#### 3. **Set the Correct Working Directory** - - Always use the absolute path for the `WorkingDirectory`. Do **not** use `$CODEROOT` in the `WorkingDirectory` field. - -#### 4. **Ensure the `.env` File Exists** - - Verify that the path in the `EnvironmentFile` line points to a valid `.env` file located in the root directory of the Talawa-Admin repository. - -#### 5. **Adjust User and Group** - - Modify the `User` and `Group` settings to match the user account intended to run the service. - ---- - -### Steps to Enable and Manage the Service - -1. **Reload the systemd daemon** to apply changes: - ```bash - sudo systemctl daemon-reload - ``` - -2. **Start the Talawa-Admin Service**: - ```bash - sudo systemctl start talawa_admin.service - ``` - -3. **Stop the Talawa-Admin Service**: - ```bash - sudo systemctl stop talawa_admin.service - ``` - -4. **Enable the Service to Start on Boot**: - ```bash - sudo systemctl enable talawa_admin.service - ``` - ---- - -### Troubleshooting - -- If you encounter any issues, you can check the status and logs of the service: - ```bash - sudo systemctl status talawa_admin.service - sudo journalctl -u talawa_admin.service - ``` - ---- - -By following these steps, you can set up and manage the Talawa-Admin service efficiently on your Linux server. \ No newline at end of file