NoMongo: Update INSTALLATION.md to cover the steps in the current videos

[palisadoes]

Is your feature request related to a problem? Please describe.

1. We are relying on videos to show how to setup the code in the new develop-postgres branch
   1. https://www.youtube.com/watch?v=10Zi2srGPHM&list=PLv50qHwThlJWfB2AGh99gDLiX_OIyZWeJ
2. If there are changes, we have to create a new video which could lead to inconsistencies in both quality and content between versions.

Describe the solution you'd like

1. Update INSTALLATION.md to be as comprehensive as that in develop
2. Focus only on the parameters that are changed in the videos at this time
3. Wherever possible use CLI commands
4. At the end of the document it will be important to show ways to test the installation such as using
   1. CURL
   2. iGraphQL
5. Try to limit the use of imagery

Describe alternatives you've considered

• Videos, which have the limitations mentioned above

Approach to be followed (optional)

• See above

Additional context

• N/A

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

• Student Internship Programs talawa#359

[raggettii]

@palisadoes Please assign this to me

[palisadoes]

@palisadoes Please assign this to me

We'll assign to someone else so that others can get a chance

[MohitMaulekhi]

assign

[ayush-patel1]

@palisadoes assign it to me

[palisadoes]

@MohitMaulekhi

Background

1. This comment lists the URLs for accessing the API: 1. NoMongo:Fixing the 404 error even after having a running talawa-api talawa-admin#3266 (comment)
2. This is not documented in the INSTALLATION.md file
3. Talawa-Admin expects the API to be listening on port 4000. The current configuration is 8080
4. The content below is for envFiles/.env.devcontainer

   API_BASE_URL=http://127.0.0.1:8080
   API_HOST=0.0.0.0
   API_IS_GRAPHIQL=true
   API_PORT=8080
   CI=false
   NODE_ENV=production
   API_MAPPED_HOST_IP=127.0.0.1
   API_MAPPED_PORT=8080
   CADDY_HTTP_MAPPED_PORT=80
   CADDY_HTTPS_MAPPED_PORT=443
   CADDY_HTTP3_MAPPED_PORT=443
   CADDY_TALAWA_API_DOMAIN_NAME=localhost
   CADDY_TALAWA_API_HOST=api
   CADDY_TALAWA_API_PORT=8080
   CLOUDBEAVER_ADMIN_NAME=talawa
   CLOUDBEAVER_ADMIN_PASSWORD=password
   CLOUDBEAVER_MAPPED_HOST_IP=127.0.0.1
   CLOUDBEAVER_MAPPED_PORT=8978
   CLOUDBEAVER_SERVER_NAME=Talawa CloudBeaver Server
   CLOUDBEAVER_SERVER_URL=http://127.0.0.1:8978
   

5. The content below is for envFiles/.env.devcontainer

   API_BASE_URL=http://127.0.0.1:8080
   API_HOST=0.0.0.0
   API_IS_GRAPHIQL=false
   API_PORT=8080
   CI=true
   NODE_ENV=production
   CADDY_HTTP_MAPPED_PORT=80
   CADDY_HTTPS_MAPPED_PORT=443
   CADDY_HTTP3_MAPPED_PORT=443
   CADDY_TALAWA_API_DOMAIN_NAME=localhost
   CADDY_TALAWA_API_HOST=api
   CADDY_TALAWA_API_PORT=8080
   

6. The content below is for envFiles/.env.devcontainer

   API_BASE_URL=
   API_HOST=0.0.0.0
   API_IS_GRAPHIQL=false
   API_PORT=8080
   CI=false
   NODE_ENV=production
   CADDY_HTTP_MAPPED_PORT=80
   CADDY_HTTPS_MAPPED_PORT=443
   CADDY_HTTP3_MAPPED_PORT=443
   CADDY_TALAWA_API_DOMAIN_NAME=
   CADDY_TALAWA_API_HOST=api
   CADDY_TALAWA_API_PORT=8080
   

Other

1. I've opened an issue to replace all references to 8080 with 4000 for Admin compatibility. Use 4000 in your documentation
   1. NoMongo: Update the envFiles/ configurations to be compatible with Talawa Admin #2860
2. Make reference to how to get iGraphQL access
3. You don't need to make reference to the CADDY* parameters in the guide
4. Explain how to use the Cloud Beaver service for development

[palisadoes]

@MohitMaulekhi

In your documentation, note that the URIs for graphQL and iGraphQL are:

/graphql
/graphiql

[palisadoes]

Unassigning. This PR was a cut and paste of the document in the develop branch. There is too much extraneous information that will lead people astray. This is a very important document and needs to be taken seriously. We're going to have to assign this to someone else.

• Updating installation.md #2865

This needs to be assigned to someone who has successfully installed the API in the develop-postgres branch

[MohitMaulekhi]

@palisadoes pls reassign me . I have taken the task seriously and put my time learning proper installation of the api. I have copied only the part of installing some dependency(cause I thought they are necessary to provide and should be identical to develop) and the Api endpoint to access the Api was same because u said that we will not the change the access api endpoints in talawa-admin and talawa mobile. Rather that you can see I have added all the details and added warning for the disparencies in the video.
How would I know that postgres-test should be used in place of postgres_test if I haven't installed the api locally.
Will do the required changes this time.

[MohitMaulekhi]

@palisadoes,

1. API URL Configuration

Currently, the API URL for the develop-postgres branch is configured as follows:

• GraphiQL: http://127.0.0.1:4000/graphiql
• WebSocket: ws://127.0.0.1:4000/graphql/ However, talawa-admin` expects the default URL to be:
• GraphQL: http://localhost:4000/graphql/
• WebSocket: ws://localhost:4000/graphql/

To resolve this inconsistency, we have two options:

1. Update the installation.md file in talawa-admin repository to reflect the current URLs.
2. Modify the environment variables in talawa-api to match the expected URLs.

Could you please indicate your preferred option?

2. Enhancements for the Installation Guide

There are a few important steps that are not covered in the current video, which I believe should be included in the installation guide. Your thoughts on adding these would be appreciated:

• Docker and VS Code + devContainer Configuration and Installation: Detailed steps to set up Docker and VS Code with devContainers.
• Commands to Run the Server: Clear instructions on how to start the server, especially since stopping the server can require manual intervention to restart it.
• Guide for Forking the Repository: A step-by-step guide to fork the repository and work on the forked repo, which is essential for new contributors(which will be same as in the old develop branch).

3. Remote Access to the API

I am unable to access the talawa-api on remote access. The URL I am using is http://<ip>:4000/graphql. I have tried checking the firewall and reinstalled the setup multiple times. Remote access is necessary for the talawa-mobile development. Given that the API host server is set to "0.0.0.0", remote access should be available.

Please let me know if remote access is not yet configured for the API, or if this issue is specific to my setup. This will help me update the installation guide accordingly.

[palisadoes]

1. The API endpoints must remain unchanged. When the installation guide is complete, then we can fix the Admin documentation
2. We need the two approaches documented
3. Open an issue for this and let @xoldd be aware. Please focus on the documentation not the fix. When the issue is resolved, then the documentation can be updated.

[palisadoes]

1. I closed your PR because it was failing tests.
2. I migrated the INSTALLATION.md file in your PR to docs/docs/docs/getting-started/installation.md with significant modifications.
3. This was done to ensure that we had the new installation process documented for the develop-postgres migration which was completed a few hours ago
   • Login workflow resolution for develop-postgres API talawa-admin#3400
4. Please take a look at the file, to see what improvements can be made. Changes to the new file automatically update:
   • https://docs-admin.talawa.io/docs/installation