Restructure Repository with Modular Domain-Based README Files and Direct Access from main README #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

swapna-shree wants to merge 5 commits into keploy:main from swapna-shree:swapna-shree

README.md

Large diffs are not rendered by default.

contributing.md

-Original file line number
+Diff line change
@@ Expand Up @@
     ---
-    ## Adding a New Use Case
-    If you're adding a completely new use case that doesn't fit into the existing categories, follow these steps:
-. **Find the right domain**
-       If it fits into an existing category, place it under the right domain section in **README.md**.
-. **Create a new section**
-       If it's a completely new use case and domain, add a new section at the bottom of the **README.md**.
+    ## Adding a New Use Case or Domain
+    #### If it fits into an existing domain:
+. Navigate to the appropriate domain folder inside the `domains/` directory.
+. Open its `README.md`.
+. Add your new use case as a bullet point or sub-section in that file.
+. Follow the existing formatting for consistency.
+    #### If it's a completely new domain:
+. Inside the `domains/` directory, create a new folder with a meaningful name (e.g., `mobile-development`).
+. Inside that folder, create a `README.md` file.
+. Add your use cases and prompts inside this new `README.md`.
+. At the bottom of the main `README.md` (root level), add a new entry to the Table of Contents linking to your new domain:
+    ```md
+      [Mobile Development](domains/mobile-development/README.md)
+    ```
     ---
     ## Thank You!
     We truly appreciate your contributions! By helping us expand and improve this collection of prompts, you’re making it easier for developers to work more efficiently and with less effort.
@@ Expand Down @@

domains/api-development/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,37 @@
+    # **13. API Development**
+    * **Generate OpenAPI Schema from Source Code**
+      ```text
+      "Given the following source code for a RESTful API implemented in {programming_language} with endpoints {list_of_endpoints}, generate an OpenAPI 3.0 schema that describes the API. The schema should include paths, request/response parameters, status codes, authentication methods, and other relevant details. Return the complete OpenAPI schema in YAML format."
+      ```
+    * **Generate Curl Commands for Testing OpenAPI Endpoints**
+      ```text
+      "For the OpenAPI schema provided, generate `curl` commands to test the endpoints. Include examples for GET, POST, PUT, and DELETE requests. The `curl` commands should include the correct headers, body content (for POST/PUT), and any required authentication tokens (if applicable)."
+      ```
+    * **Generate OpenAPI Schema for a Custom API with Source Code**
+      ```text
+      "Given the following source code for an API implemented in {programming_language}, generate the OpenAPI schema for this API. The schema should cover all routes, parameters, request/response types, and status codes. Include both request body and query parameters where applicable, and provide the schema in YAML format."
+      ```
+    * **Create OpenAPI Schema and Curl Commands for a CRUD API**
+      ```text
+      "Create an OpenAPI schema for a simple CRUD API with the following endpoints: `GET /items`, `POST /items`, `PUT /items/{id}`, and `DELETE /items/{id}`. Based on the schema, generate `curl` commands to test these endpoints with sample data, including headers and request bodies as necessary."
+      ```
+    * **Generate OpenAPI Schema for a Node.js API and Curl Examples**
+      ```text
+      "Given the following source code for a Node.js API using Express, generate the corresponding OpenAPI 3.0 schema. Then, create `curl` commands to test each endpoint in the API, covering all HTTP methods (GET, POST, PUT, DELETE) and including sample request bodies for each method."
+      ```
+    * **Keploy CI/CD Integration Setup**
+      ```text
+      "Set up a CI/CD pipeline to automatically run Keploy tests as part of the deployment process. Include configuration for GitHub Actions or Jenkins to run tests whenever new code is pushed to the repository."
+      ```

domains/backend-development/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,151 @@
+    # Backend Development Prompts
+    ### 1. Authentication & Authorization
+    * **Secure Auth System**
+      ```text
+      Implement a secure user authentication system using {auth_strategy}. Include login, registration, token/session-based authentication, and role-based access control.
+      ```
+    * **Social Login**
+      ```text
+      Implement a social login system supporting {oauth_provider}. Include account linking, user profile handling, and secure token storage.
+      ```
+    ### 2. Database & ORM
+    * **Relational Database Schema**
+      ```text
+      Create models and schema for a relational database using {orm_tool}. Include relationships, constraints, and migrations.
+      ```
+    * **Document-Oriented Models**
+      ```text
+      Define document-based models for use with a NoSQL database like {nosql_database}. Include embedded documents, references, and validation rules.
+      ```
+    ### 3. Middleware & Request Handling
+    * **Middleware Stack Setup**
+      ```text
+      Configure a middleware stack using {server_framework}. Include request parsing, logging, security (CORS, rate limiting), and error handling.
+      ```
+    * **Custom Middleware Logic**
+      ```text
+      Implement custom middleware to validate headers or authentication tokens. Make it reusable across multiple routes in {server_framework}.
+      ```
+    ### 4. RESTful APIs
+    * **Versioned REST API**
+      ```text
+      Implement a versioned REST API using {server_framework}. Include CRUD routes, query filtering, pagination, and consistent response formatting.
+      ```
+    * **REST API Documentation**
+      ```text
+      Auto-generate API documentation using {doc_tool}. Cover endpoints, request/response schemas, authentication flow, and examples.
+      ```
+    ### 5. Real-Time Features
+    * **Socket/Streaming System**
+      ```text
+      Build a real-time messaging system using {realtime_library}. Include room handling, connection tracking, and broadcasting logic.
+      ```
+    ### 6. GraphQL APIs
+    * **Modular GraphQL Server**
+      ```text
+      Create a modular GraphQL API server with schema, queries, mutations, and error handling using {graphql_server}.
+      ```
+    ### 7. Security
+    * **CORS & Headers**
+      ```text
+      Configure CORS and security headers for your backend using {server_framework}. Support custom origin rules and header restrictions.
+      ```
+    * **Secure Environment Setup**
+      ```text
+      Configure secure environment variable handling for different stages (dev, test, prod) using {env_tool}. Include .env templates and code usage.
+      ```
+    ### 8. File Upload & Storage
+    * **File Upload Handler**
+      ```text
+      Implement a backend file upload system using {upload_library}. Support file validation, error handling, and storage to {storage_provider}.
+      ```
+    ### 9. Notifications
+    * **Email Sending System**
+      ```text
+      Build a transactional email sender using {email_service}. Include dynamic templates, scheduling, and error recovery.
+      ```
+    ### 10. Testing & Debugging
+    * **Backend Test Suite**
+      ```text
+      Write unit and integration tests for backend routes using {test_library}. Include mock database setups and error condition testing.
+      ```
+    ### 11. Deployment
+    * **Deployable Backend Setup**
+      ```text
+      Provide configuration for deploying a backend app using {platform}. Include environment setup, CI pipeline overview, and rollback strategy.
+      ```
+    ### 12. Logging & Monitoring
+    * **Structured Logging**
+      ```text
+      Implement structured logging using {logging_tool}. Include request tracing, error logs, and contextual metadata.
+      ```
+    * **Error Tracking Setup**
+      ```text
+      Integrate error tracking using {monitoring_tool}. Include user context, stack traces, and alerting rules.
+      ```
+    ### 13. Job Queues
+    * **Async Job Queue**
+      ```text
+      Implement a job queue using {queue_system}. Handle retries, concurrency, and job status tracking.
+      ```
+    ### 14. Performance & Optimization
+    * **Optimize Backend Performance**
+      ```text
+      Optimize backend performance using techniques like {optimization_technique}. Include caching, database tuning, and asynchronous processing.
+      ```
+    ---

domains/ci-cd-devops/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,86 @@
+    # **2. CI/CD & DevOps**
+    * **Set up CI/CD Pipelines**
+      ```text
+      "Help set up a CI/CD pipeline for the project using {CI_tool}. The pipeline should include stages for building, testing, and deploying the application. Provide configuration files and explanations of each stage."
+      ```
+    * **Automate Code Formatting**
+      ```text
+      "Set up an automated code formatting system using {tool}. Configure it to run on each commit or via pre-commit hooks. Return the necessary configuration and explain how it integrates into the workflow."
+      ```
+    * **Set up Cloud Cost Optimization Strategies**
+      ```text
+      "Provide strategies for optimizing cloud costs in {cloud_provider}. Focus on areas like reserved instances, auto-scaling, and rightsizing. Return recommendations and examples of how to implement them."
+      ```
+    * **Create Docker Compose Configurations**
+      ```text
+      "Create a Docker Compose configuration file to set up {services}. The configuration should include service dependencies, environment variables, and port mappings. Return the Docker Compose YAML with an explanation."
+      ```
+    * **Generate Cron Jobs for Task Scheduling**
+      ```text
+      "Write cron jobs to schedule tasks on a Linux system. The tasks should run at {interval} and execute {command}. Return the cron job configurations with explanations of each field."
+      ```
+    * **Implement Automated Security Testing in CI/CD**
+      ```text
+      "Integrate automated security testing tools like {security_tool} into the CI/CD pipeline. Configure the pipeline to run security checks on each commit or pull request. Return the updated pipeline configuration."
+      ```
+    * **Set up Serverless Architecture with Google Cloud Functions**
+      ```text
+      "Create a serverless architecture using Google Cloud Functions for {task}. The functions should trigger based on specific events and return the necessary code with setup instructions."
+      ```
+    * **Write Infrastructure as Code (IaC) for AWS with CloudFormation**
+      ```text
+      "Write infrastructure-as-code (IaC) for AWS using CloudFormation. Automate the provisioning of resources such as EC2, RDS, and S3 for {application}. Return the CloudFormation templates with explanations."
+      ```
+    * **Create a Custom Shell Script for System Administration**
+      ```text
+      "Create a custom shell script that automates {system_task} such as backups, log rotations, or user management. The script should be efficient and handle errors gracefully. Return the shell script with usage instructions."
+      ```
+    * **Create an Event-Driven Architecture with Kafka**
+      ```text
+      "Set up an event-driven architecture with Kafka. Define the Kafka topics, producers, and consumers to handle real-time data processing. Return the code with configuration details."
+      ```
+    * **Implement Data Preprocessing for Machine Learning**
+      ```text
+      "Implement data preprocessing steps for machine learning. This includes handling missing data, scaling features, and encoding categorical variables. Return the preprocessing code and explain each step."
+      ```
+    * **Implement Serverless Functions on AWS Lambda**
+      ```text
+      "Set up serverless functions using AWS Lambda to perform {task}. Include setup instructions for the trigger and return the Lambda function code."
+      ```
+    * **Set up Google Analytics for Portfolio Tracking**
+      ```text
+      "Set up Google Analytics tracking for my portfolio website. Provide the steps for adding tracking code and configuring goals. Return the setup instructions."
+      ```
+    * **Optimize a Docker-Based Development Environment**
+      ```text
+      "Optimize the provided Docker development environment. Focus on reducing build time, improving caching, and streamlining container configurations. Return the optimized Dockerfile and Docker Compose file."
+      ```

domains/cloud-kubernetes/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,20 @@
+    # **4. Cloud & Kubernetes**
+    * **Set Up Kubernetes Cluster on AWS EKS**
+      ```text
+      "Please guide the setup of a Kubernetes cluster using Amazon EKS. Include steps for configuring the cluster, setting up node groups, and connecting kubectl. Return the steps and configuration files."
+      ```
+    * **Implement Persistent Storage in Kubernetes Using StatefulSets**
+      ```text
+      "Set up persistent storage in Kubernetes using StatefulSets. Configure PersistentVolumeClaims (PVC) and explain how it ensures data persistence. Return the YAML configuration files."
+      ```
+    * **Set Up Cloud Storage with Amazon S3**
+      ```text
+      "Please provide the steps for setting up cloud storage using Amazon S3. Include how to create a bucket, set permissions, and manage files programmatically via AWS SDKs. Return the necessary code examples for integration."
+      ```

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Restructure Repository with Modular Domain-Based README Files and Direct Access from main README #56

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Restructure Repository with Modular Domain-Based README Files and Direct Access from main README #56

Are you sure you want to change the base?

Uh oh!

Restructure Repository with Modular Domain-Based README Files and Direct Access from main README #56

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!