feat: Installation.md added with few sample data (without Docker)

[bandhan-majumder]

What kind of change does this PR introduce?

Issue Number: #2666

Snapshots/Videos:

Migrations are applied:

Sample data loaded, graphql sdl file generated, server starts

Endpoint working

If relevant, did you update the documentation?
Added installation process in INSTALLATION.md file.

Summary
Local installation steps without docker with sample data loaded and working steps are defined in INSTALLATION.md file.

Other information
As I added some files which are crucial for sample data import, please git clone https://github.com/bandhan-majumder/talawa-api/tree/develop-postgres and the rest of the steps are as it is.

Have you read the contributing guide?

yes

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)

• dev-postgres

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

1. The overall code coverage drops below the target threshold of the repository
2. Any file in the pull request has code coverage levels below the repository threshold
3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

1. PRs with issues not assigned to you will be closed by the reviewer
2. Fix the first comment in the PR so that each issue listed automatically closes

Other

1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
2. Read the CONTRIBUTING.md file make

[github-actions]

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

[palisadoes]

1. Please work with @xoldd here and in the slack #talawa-api channel to make sure this is appropriate.
2. We need the sample data to help with testing and to create a demo site so that users can determine whether they want to use the app or not.

[palisadoes]

@xoldd

We will need a way for people to test the application by seeing what it can do. The loading of sample data via the setup script helps a lot. It also helps with the new contributors as they can get a better understanding of the features.

We really need this. How can you facilitate this with the coding you are doing?

[bandhan-majumder]

Sure. I would love to apply the suggestions/modifications of @xoldd. And @palisadoes, can u please merge his PR #2698. I will be able to test the user authentication functionalities. Thank you :)

[palisadoes]

Sure. I would love to apply the suggestions/modifications of @xoldd. And @palisadoes, can u please merge his PR #2698. I will be able to test the user authentication functionalities. Thank you :)

It's merged

[xoldd]

According to me this way of seeding the database is bad and should not be carried out. Also, there are two types of database seeds, one is for dummy data that is only useful in development, testing environments etc., and one is for data that is common in all environments including the production. Creation of the administrator user associated to the API_ADMINISTRATOR_USER_EMAIL_ADDRESS and API_ADMINISTRATOR_USER_PASSWORD environment variables is a seed operation that is common for all environments.

Since there isn't a concept of service layer, for now the graphql resolvers are the single source of truth for most of the business logic. Database seeding will be done by triggering graphql mutation operations. Manually inserting data into the database like this is just gonna lead to duplication of business logic, inconsistency and seed data corruption.

[bandhan-majumder]

Thanks @xoldd . I think I should close this PR. The recent merge will change the script a bit (npm to pnpm). I have already written the script. It's working and the mutations (signUp) are also inserting data into database successfully. I have checked a few queries and mutations. After checking the rest of them (based on the recent merge), I will raise a new PR with installation script and screenshot proof.

[palisadoes]

We need a way to have demo data for prospective end users to evaluate the product.

It has real value in helping us get adoption of an MVP.

We will have to open this issue again when the postgres DB work is complete.