Skip to main content

Introduction

Welcome to the Talawa-API developer resources.

Important Directories

Review these important locations before you start your coding journey.

DirectoryDescription
devcontainerContains the devcontainer configuration file.
docker/Contains Docker configuration files.
drizzle_migrations/Definitions that allow the the Drizzle ORM to modify the structure of a database schema by adding, removing, or changing columns in tables, essentially allowing you to update your database schema programmatically without writing raw SQL commands, ensuring that changes are tracked and can be applied consistently across different environments.
envFiles/Contains .env files for production, development and CI/CD pipelines
src/drizzleContains drizzle-orm schema definitions for the postgres database.
src/graphqlUsed for storing all pothos schema definitions used for Talawa-API's graphql implementation.
src/graphql/enumsUsed for storing the schema definitions for the graphql inputs used in the Talawa-API's graphql implementation.
src/graphql/inputsUsed for storing the schema definitions for the graphql inputs used in the Talawa-API's graphql implementation.
src/graphql/interfacesUsed for storing the schema definitions for the graphql interfaces used in the Talawa-API's graphql implementation.
src/graphql/scalarsUsed for storing the schema definitions for the graphql scalars used in the Talawa-API's graphql implementation.
src/graphql/typesUsed for storing the schema definitions for the graphql types used in the Talawa-API's graphql implementation.
src/graphql/unionsUsed for storing the schema definitions for the graphql unions used in the Talawa-API's graphql implementation.
src/pluginsContains the fastify plugins used to extend the base functionality of the fastify instance either for usage in other plugins or for usage in the route plugins.
src/routesUsed for storing the schema definitions for the graphql enums used in the Talawa-API's graphql implementation.
testContains the code for performing api tests against Talawa-API. The tests in this directory must follow the practices of black box testing and most of them should be written to be able to run concurrently.
test/routes/graphqlContains the code for performing api tests against Talawa-API. The tests in this directory must follow the practices of black box testing and most of them should be written to be able to run concurrently.