MCPcopy Index your code
hub / github.com/PalisadoesFoundation/talawa-api

github.com/PalisadoesFoundation/talawa-api @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
2,011 symbols 9,929 edges 1,609 files 299 documented · 15%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Talawa API

💬 Join our community forum to meet others using and improving Talawa!

N|Solid

License: GPL v3 GitHub stars GitHub forks codecov Formatted with Biome Linted with Biome Checked with Biome

Talawa is a modular open source project to manage group activities of both non-profit organizations and businesses.

Core features include:

  1. Membership management
  2. Groups management
  3. Event registrations
  4. Recurring meetings
  5. Facilities registrations

talawa is based on the original quito code created by the Palisadoes Foundation 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 for more details on its origin and activities.

Table of Contents

Talawa Components

talawa has these major software components:

  1. talawa: A mobile application with social media features
  2. talawa-api: An API providing access to user data and features
  3. talawa-admin: A web based administrative portal
  4. talawa-plugin: Microkernel-based drop-in plugins for Talawa-Admin
  5. talawa-docs: The online documentation website

Documentation

  1. You can install the software for this repository using the steps in our INSTALLATION.md file.
  2. Do you want to contribute to our code base? Look at our CONTRIBUTING.md file to get started. There you'll also find links to:
  3. Our code of conduct documentation in the CODE_OF_CONDUCT.md file.
  4. How we handle the processing of new and existing issues in our ISSUE_GUIDELINES.md file.
  5. The methodologies we use to manage our pull requests in our PR_GUIDELINES.md file.
  6. The talawa documentation can be found at our docs.talawa.io site.
  7. It is automatically generated from the markdown files stored in our Talawa-Docs GitHub repository. This makes it easy for you to update our documenation.

Videos

  1. Visit our YouTube Channel playlists for more insights
  2. The "Getting Started - Developers" videos are extremely helpful for new open source contributors. <- Update verification script guidance Trigger CI -->

Extension points exported contracts — how you extend this code

CacheService (Interface)
(no doc) [6 implementers]
src/services/caching/CacheService.ts
ServerWithAuthEnv (Interface)
* Minimal server shape required for REST admin sign-in. * Tests pass the same server instance from test/server.ts.
test/helpers/adminAuthRest.ts
GraphQLError (Interface)
* GraphQL error structure with optional extensions
test/graphql/types/createRegularUserUsingAdmin.ts
FastifyRequestWithPluginContext (Interface)
* Extended FastifyRequest with plugin context
src/plugin/pluginWebhooks.ts
RateLimitEntry (Interface)
* Simple in-memory rate limiter for email verification requests. * * Note: This is an in-memory solution that won't wo
src/utilities/emailVerificationRateLimit.ts
SnapshotWithTimestamp (Interface)
* Snapshot with timestamp for time-based filtering.
src/fastifyPlugins/performance.ts
MultipartPayloadOptions (Interface)
(no doc)
test/helpers.ts
MockFastifyRequest (Interface)
(no doc)
test/plugin/pluginWebhooks.test.ts

Core symbols most depended-on inside this repo

assertToBeNonNullish
called by 3864
test/helpers.ts
createMockGraphQLContext
called by 699
test/_Mocks_/mockContextCreator/mockContextCreator.ts
createRegularUserUsingAdmin
called by 509
test/graphql/types/createRegularUserUsingAdmin.ts
get
called by 285
src/services/caching/CacheService.ts
set
called by 273
src/services/caching/CacheService.ts
inject
called by 251
test/helpers/adminAuthRest.ts
register
called by 178
src/utilities/auth/oauth/OAuthProviderRegistry.ts
createPerformanceTracker
called by 175
src/utilities/metrics/performanceTracker.ts

Shape

Function 1,334
Method 314
Interface 270
Class 86
Enum 7

Languages

TypeScript98%
Python2%

Modules by API surface

test/scripts/test_disable_statements_check.py38 symbols
scripts/validate_error_handling.ts34 symbols
src/plugin/manager/core.ts31 symbols
src/plugin/manager/lifecycle.ts26 symbols
scripts/setup/setup.ts25 symbols
test/utilities/leakyBucket.test.ts24 symbols
src/plugin/types.ts22 symbols
src/utilities/metrics/performanceTracker.ts21 symbols
src/plugin/utils.ts20 symbols
src/install/utils/logger.ts14 symbols
test/helpers/mailpitHelpers.ts13 symbols
src/graphql/types/Notification/EventBus/eventBus.ts13 symbols

For agents

$ claude mcp add talawa-api \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page