updated documentation

README.md

@@ -2,7 +2,7 @@
 
 💬 Join the community on Slack from our [Palisadoes Foundation GitHub Home Page](https://github.com/PalisadoesFoundation)
 
-[![N|Solid](public/markdown/images/talawa-logo-lite-200x200.png)](https://github.com/PalisadoesFoundation/talawa-api)
+[![N|Solid](docs/static/img/markdown/misc/talawa-logo-lite-200x200.png)](https://github.com/PalisadoesFoundation/talawa-api)
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/talawa-api.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-api)
@@ -24,11 +24,11 @@ Core features include:
 
 `talawa` is based on the original `quito` code created by the [Palisadoes Foundation](http://www.palisadoes.org) as part of its annual Calico Challenge program. Calico provides paid summer internships for Jamaican university students to work on selected open source projects. They are mentored by software professionals and receive stipends based on the completion of predefined milestones. Calico was started in 2015. Visit [The Palisadoes Foundation's website](http://www.palisadoes.org/) for more details on its origin and activities.
 
-##  Table of Contents
+## Table of Contents
 
 <!-- toc -->
 
-  - [Talawa Components](#talawa-components)
+- [Talawa Components](#talawa-components)
 - [Documentation](#documentation)
   - [Videos](#videos)
 
@@ -47,11 +47,11 @@ Core features include:
 
 1. You can install the software for this repository using the steps in our [INSTALLATION.md](INSTALLATION.md) file.
 1. Do you want to contribute to our code base? Look at our [CONTRIBUTING.md](CONTRIBUTING.md) file to get started. There you'll also find links to:
-    1. Our code of conduct documentation in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.
-    1. How we handle the processing of new and existing issues in our [ISSUE_GUIDELINES.md](ISSUE_GUIDELINES.md) file.
-    1. The methodologies we use to manage our pull requests in our [PR_GUIDELINES.md](PR_GUIDELINES.md) file.
+   1. Our code of conduct documentation in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.
+   1. How we handle the processing of new and existing issues in our [ISSUE_GUIDELINES.md](ISSUE_GUIDELINES.md) file.
+   1. The methodologies we use to manage our pull requests in our [PR_GUIDELINES.md](PR_GUIDELINES.md) file.
 1. The `talawa` documentation can be found at our [docs.talawa.io](https://docs.talawa.io) site.
-    1. It is automatically generated from the markdown files stored in our [Talawa-Docs GitHub repository](https://github.com/PalisadoesFoundation/talawa-docs). This makes it easy for you to update our documenation.
+   1. It is automatically generated from the markdown files stored in our [Talawa-Docs GitHub repository](https://github.com/PalisadoesFoundation/talawa-docs). This makes it easy for you to update our documenation.
 
 ## Videos
 

docs/docs/docs/getting-started/installation.md

@@ -196,7 +196,70 @@ Click on the image below to play the video.
 
 Follow these steps to have the best experience
 
-### IDE Setup
+#### Using the CLI
+
+These steps are specific to Linux. You will need to modify them accordingly for other operating systems
+
+1. Install `docker` and ensure that the daemon is running.
+1. Install the PostgreSQL database
+   ```bash
+   sudo apt-get -y install postgresql postgresql-contrib
+   sudo systemctl enable postgresql.service
+   sudo systemctl start postgresql.service
+   ```
+1. Connect to the PostgreSQL CLI
+
+   ```bash
+   sudo -u postgres psql
+
+   ```
+
+1. Create the database, grant permissions then exit
+   ```sql
+   CREATE DATABASE talawa;
+   CREATE USER talawa WITH PASSWORD 'password';
+   GRANT ALL PRIVILEGES ON DATABASE talawa TO talawa;
+   GRANT ALL ON SCHEMA public TO talawa;
+   ```
+1. Exit the PostgreSQL CLI
+   ```bash
+   exit
+   ```
+1. Create the `.env` file by copying the template from the `envFiles/` directory
+   ```bash
+   cp envFiles/.env.devcontainer .env
+   ```
+1. Change the `.env` file's `API_POSTGRES_HOST` parameter to `localhost`.
+   ```ini
+   API_POSTGRES_HOST=localhost
+   ```
+1. Install the packages
+   ```bash
+   pnpm install
+   ```
+1. Intall the `devcontainers/cli` package
+   ```
+   pnpm install -g @devcontainers/cli
+   ```
+1. You will now need to make your user a part of the `docker` operating system group or else you will get `permission denied` messages when starting docker later. `$USER` is a universal representation of your username. You don't need to change this in the command below.
+   ```
+   sudo usermod -a -G docker $USER
+   ```
+1. You will only become a part of the `docker` group on your next login. You don't have to logout, just start another session on the CLI using the `su` command.
+   ```
+   sudo su $USER -
+   ```
+1. Start the docker devcontainer
+   ```
+   devcontainer build --workspace-folder .
+   ```
+1. When startup is complete, the last like of the output should be:
+   ```
+   {"outcome":"success","imageName":"talawa-api"}
+   ```
+   All done!
+
+#### Using the VScode IDE
 
 1. Open cloned talawa-api project in Visual Studio Code.
 2. You should see a notification that a `devcontainer` configuration file is available. Click on the notification and select `Reopen in Container`.
@@ -205,7 +268,7 @@ Follow these steps to have the best experience
 3. 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.
 4. Wait till the process is complete and you see ports being forwarded in the terminal.
 5. You can check logs by clicking `Connecting to Dev Container (show log)`;
-6. Create a new terminal in Visual Studio Code by pressing ``Ctrl+Shift+` ``.
+6. Create a new terminal in Visual Studio Code by pressing `` Ctrl+Shift+`  ``.
 7. Run the `pwd` command to confirm you are in the `/home/talawa/api` directory.
 8. Run the following command to check if the project has required dependencies installed correctly:
    ```bash