[
{
"path": ".babelrc",
"content": "{\n \"presets\": [\"@babel/preset-env\"],\n \"plugins\": [\"@babel/plugin-syntax-import-assertions\"]\n}"
},
{
"path": ".commitlintrc.json",
"content": "{\n \"extends\": [\"@commitlint/config-conventional\"],\n \"rules\": {\n \"type-enum\": [\n 2,\n \"always\",\n [\n \"ci\",\n \"chore\",\n \"docs\",\n \"feat\",\n \"fix\",\n \"perf\",\n \"refactor\",\n \"revert\",\n \"style\",\n \"assets\",\n \"test\"\n ]\n ]\n }\n}\n"
},
{
"path": ".dockerignore",
"content": "/.vscode\n/node_modules"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.yaml",
"content": "name: 🐞 Bug report\ndescription: Create a report to help us improve\ntitle: \"BUG: \"\n\nlabels:\n - bug\n\nbody:\n - type: textarea\n id: bug_description\n attributes:\n label: Describe the bug\n description: A clear and concise description of what the bug is.\n validations:\n required: true\n\n - type: textarea\n id: reproduce_steps\n attributes:\n label: To Reproduce\n description: Steps to reproduce the behavior.\n validations:\n required: false\n\n - type: textarea\n id: expected_behavior\n attributes:\n label: Expected behavior\n description: A clear and concise description of what you expected to happen.\n validations:\n required: false\n\n - type: textarea\n id: screenshots\n attributes:\n label: Screenshots\n description: If applicable, add screenshots to help explain your problem.\n\n - type: input\n id: os_info\n attributes:\n label: OS\n description: Operating System information (e.g., iOS).\n placeholder: MacOS\n validations:\n required: false\n \n - type: input\n id: version_info\n attributes:\n label: OS Version\n description: OS Version information.\n placeholder: \"13.1\"\n validations:\n required: false\n\n - type: input\n id: client_info\n attributes:\n label: Client\n description: Client information (e.g., postman, thunder client, chrome, safari).\n placeholder: Postman\n validations:\n required: false\n\n\n\n - type: textarea\n id: additional_context\n attributes:\n label: Additional context or Information\n description: Add any other context or any other information about the problem here.\n\n"
},
{
"path": ".github/ISSUE_TEMPLATE/code_coverage.yaml",
"content": "name: 🧪 Testing Contribution\ndescription: Share details about your test coverage for contribution to FreeAPI.\ntitle: \"TESTING: <title>\"\n\nlabels:\n - testing\n\nbody:\n - type: textarea\n id: test_description\n attributes:\n label: Describe the test\n description: A clear and concise description of the proposed testing suite.\n validations:\n required: true\n\n - type: textarea\n id: additional_info\n attributes:\n label: Additional Information\n description: Add any extra details or considerations that might be relevant such as screenshots.\n validations:\n required: false\n"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"content": "blank_issues_enabled: true\ncontact_links:\n - name: FreeAPI Discord Server\n url: https://hitesh.ai/discord\n about: Please ask and answer questions related to FreeAPI here.\n - name: Learn FreeAPI here\n url: https://www.youtube.com/playlist?list=PLRAV69dS1uWSx4erHGq8hW_GE-Eaj60r-\n about: Gain comprehensive knowledge of FreeAPI through this curated playlist."
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.yaml",
"content": "name: 🌟 Feature Request\ndescription: Suggest an enhancement, new feature or anything\ntitle: \"FEATURE: <title>\"\n\nlabels:\n - enhancement\n\nbody:\n - type: textarea\n id: feature_description\n attributes:\n label: Describe the Feature\n description: A clear and concise description of the proposed feature or enhancement.\n validations:\n required: true\n\n - type: textarea\n id: use_case\n attributes:\n label: Use Case\n description: Provide a scenario or use case where this feature would be beneficial.\n validations:\n required: false\n\n - type: textarea\n id: additional_info\n attributes:\n label: Additional Information\n description: Add any extra details or considerations that might be relevant.\n validations:\n required: false\n\n - type: textarea\n id: suggested_tools\n attributes:\n label: Suggested Tools\n description: List any tools or technologies you suggest for implementing this feature.\n validations:\n required: false\n\n - type: textarea\n id: additional_context\n attributes:\n label: Additional Context or Information\n description: Add any other context or information that might be useful for understanding the feature request.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/frontend_contribution.yaml",
"content": "name: 🚀 Frontend Contribution\ndescription: Share details about your frontend application for contribution to FreeAPI.\ntitle: \"FRONTEND: <title>\"\n\nlabels:\n - frontend\n - enhancement\n\nbody:\n - type: input\n id: app_title\n attributes:\n label: Frontend App Title\n description: Provide a title for your frontend application.\n validations:\n required: true\n\n - type: textarea\n id: overview\n attributes:\n label: Overview\n description: Briefly describe your frontend application.\n validations:\n required: true\n\n - type: textarea\n id: detailed_features\n attributes:\n label: Detailed Features\n description: List the features of your frontend application in detail.\n validations:\n required: true\n\n - type: input\n id: tech_stack\n attributes:\n label: Tech Stack Used\n description: Specify the technologies used in your frontend application (comma-separated).\n placeholder: \"ReactJs, redux, tailwindCSS...\"\n validations:\n required: true\n\n - type: input\n id: platform\n attributes:\n label: Built For Platform\n description: Specify the platform on which this application will run.\n placeholder: \"web, mobile, desktop...\"\n validations:\n required: true\n\n - type: input\n id: project_path\n attributes:\n label: Project Path\n description: Provide the path to your project within the FreeAPI project's `examples` folder.\n placeholder: E.g. $ROOT_FOLDER/examples/apps/social-media/web/react-redux-tailwind/<your_project_folders>\n validations:\n required: true\n"
},
{
"path": ".gitignore",
"content": "# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\nlerna-debug.log*\n.pnpm-debug.log*\n\n# Diagnostic reports (https://nodejs.org/api/report.html)\nreport.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json\n\n# Runtime data\npids\n*.pid\n*.seed\n*.pid.lock\n\n# Directory for instrumented libs generated by jscoverage/JSCover\nlib-cov\n\n# Coverage directory used by tools like istanbul\ncoverage\n*.lcov\n\n# nyc test coverage\n.nyc_output\n\n# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)\n.grunt\n\n# Bower dependency directory (https://bower.io/)\nbower_components\n\n# node-waf configuration\n.lock-wscript\n\n# Compiled binary addons (https://nodejs.org/api/addons.html)\nbuild/Release\n\n# Dependency directories\nnode_modules/\njspm_packages/\n\n# Snowpack dependency directory (https://snowpack.dev/)\nweb_modules/\n\n# TypeScript cache\n*.tsbuildinfo\n\n# Optional npm cache directory\n.npm\n\n# Optional eslint cache\n.eslintcache\n\n# Optional stylelint cache\n.stylelintcache\n\n# Microbundle cache\n.rpt2_cache/\n.rts2_cache_cjs/\n.rts2_cache_es/\n.rts2_cache_umd/\n\n# Optional REPL history\n.node_repl_history\n\n# Output of 'npm pack'\n*.tgz\n\n# Yarn Integrity file\n.yarn-integrity\n\n# dotenv environment variable files\n.env\n.env.development.local\n.env.test.local\n.env.production.local\n.env.local\n\n# parcel-bundler cache (https://parceljs.org/)\n.cache\n.parcel-cache\n\n# Next.js build output\n.next\nout\n\n# Nuxt.js build / generate output\n.nuxt\ndist\n\n# Gatsby files\n.cache/\n# Comment in the public line in if your project uses Gatsby and not Next.js\n# https://nextjs.org/blog/next-9-1#public-directory-support\n# public\n\n# vuepress build output\n.vuepress/dist\n\n# vuepress v2.x temp and cache directory\n.temp\n.cache\n\n# Docusaurus cache and generated files\n.docusaurus\n\n# Serverless directories\n.serverless/\n\n# FuseBox cache\n.fusebox/\n\n# DynamoDB Local files\n.dynamodb/\n\n# TernJS port file\n.tern-port\n\n# Stores VSCode versions used for testing VSCode extensions\n.vscode-test\n\n# yarn v2\n.yarn/cache\n.yarn/unplugged\n.yarn/build-state.yml\n.yarn/install-state.gz\n.pnp.*\n\n# Logs\nlogs\n\n/tmp\n/.vscode\n/.idea\n\n# ignore the image files uploaded in the public/images folder\n/public/images/*\n/public/temp/*\n\n# except .gitkeep to push empty folder to the git repo\n!/public/images/.gitkeep\n!/public/temp/.gitkeep\n\nNOTES.md\n.DS_Store\n\n# Playwright\n/test-results/\n/playwright-report/\n/blob-report/\n/playwright/.cache/\n"
},
{
"path": ".husky/commit-msg",
"content": "#!/usr/bin/env sh\n. \"$(dirname -- \"$0\")/_/husky.sh\"\n\nnpx --no-install commitlint --edit\n"
},
{
"path": ".husky/pre-commit",
"content": "#!/usr/bin/env sh\n. \"$(dirname -- \"$0\")/_/husky.sh\"\n\nnpx lint-staged --allow-empty\n"
},
{
"path": ".lintstagedrc",
"content": "{\n \"**/*.{js,json}\": [\"prettier --write\"]\n}\n"
},
{
"path": ".prettierignore",
"content": "/.vscode\n/node_modules\n./dist\n\n*.yml\n*.yaml\n\n*.env\n.env\n.env.*"
},
{
"path": ".prettierrc",
"content": "{\n \"singleQuote\": false,\n \"bracketSpacing\": true,\n \"tabWidth\": 2,\n \"trailingComma\": \"es5\",\n \"semi\": true\n}\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Contributing to FreeAPI\n\nThank you for your interest in contributing to FreeAPI! We welcome contributions from the software community to help improve and enhance this project.\n\nBy contributing, you can help make FreeAPI a more valuable resource for developers and contribute to the growth of the open-source community.\n\n## Table of Contents\n\n1. [📙 How to Contribute](#how-to-contribute)\n2. [䷫ Commit Message Format](#commit-message-format)\n3. [👨🏻⚖️ Guidelines for Contribution](#contribution-guidelines)\n4. [🚀 Contribute as a frontend developer](#frontend-contributor)\n\n## How to Contribute <a name=\"how-to-contribute\"></a>\n\nTo contribute to FreeAPI, please follow these guidelines:\n\n1. Fork the repository on GitHub.\n2. Clone your forked repository to your local machine.\n3. Create a new branch for your feature or bug fix: `git checkout -b feat/your-feature-name` or `git checkout -b fix/your-bug-fix-name` and make your changes.\n4. Run all the tests 🧪 before committing the changes and make sure all tests are passed.\n5. After all tests are passed, commit your changes with a descriptive messages: `git commit -am 'add your commit message'`.\n6. Push your changes to your forked repository: `git push origin feat/your-feature-name`.\n7. Submit a pull request to the main repository.\n\n## Commit Message Format <a name=\"commit-message-format\"></a>\n\nWe follow the conventional commit message format to provide a clear and standardized history of our project's changes. Each commit message should consist of a type and a descriptive message.\n\n| Type | Heading | Rule | Description |\n| -------- | -------- | ------------------------------------------ | --------------------------------------------------------------------------------- |\n| ci | CI | Continuous Integration | Changes related to continuous integration. |\n| chore | Chore | Maintenance tasks | Other changes that don't affect production. |\n| docs | Docs | Documentation | Changes related to documentation. |\n| feat | Feature | New Feature | New feature implementations or additions. |\n| fix | Fix | Bug Fixes | Bug fixes or corrections. |\n| perf | Perf | Performance Improvements | Performance-related improvements. |\n| refactor | Refactor | Code Refactoring | Code changes that don't fix bugs or add features, but improve the code structure. |\n| revert | Revert | Revert Previous Commits | Reverting previous commits. |\n| style | Style | Code Formatting or Style | Changes related to code formatting or style. |\n| assets | Assets | Add or Update Assets (e.g., images, files) | Changes related to adding or updating assets, such as images or other files. |\n\n### Format\n\nThe commit message should start with the type, followed by a colon and a space, and then the descriptive message in present tense.\n\nExample:\n\n- feat: add user authentication feature\n- fix: correct typo in README\n\nPlease adhere to this format when making commits. This will help us maintain a clean and organized commit history.\n\n## Guidelines for Contribution <a name=\"contribution-guidelines\"></a>\n\nHere's a guide on how you can effectively contribute to our API hub:\n\n1. Pull Requests for Readme Updates: Please refrain from sending pull requests solely for updating the project's readme file. While we appreciate the importance of clear and concise documentation, we prefer to focus on substantial code contributions and feature enhancements.\n\n2. Grammar Updates: Our team values effective communication, but we're not grammar sticklers. You don't need to send pull requests solely for grammar fixes or minor language improvements. Instead, concentrate on the core functionalities and features of the project.\n\n3. Avoid Updating Existing Public APIs: To maintain stability and consistency, we discourage direct updates to existing public APIs within the API hub. These APIs have been thoroughly tested and approved. However, if you encounter any bugs or issues, we encourage you to open an issue on our project's issue tracker to notify us.\n\n4. Build New Project APIs: We encourage you to explore your creativity and contribute by building complete project APIs. These APIs should provide comprehensive solutions that can assist developers in constructing complex projects to showcase their skills and abilities. Your contributions in this area will greatly benefit the community.\n\n5. Draft a Proposal and Discuss on Discord: Before diving into your project, we recommend drafting a proposal. This can include a mind map or outline of the API you intend to build and its potential benefits. Join our Discord community, where you can share your proposal, discuss ideas, and gather feedback from fellow contributors. Engaging in these discussions will enhance your backend portfolio and help shape the future direction of the project.\n\nWe appreciate your enthusiasm and look forward to your valuable contributions to our open source API hub project.\n\nTogether, we can foster a collaborative environment and make a significant impact in the API integration landscape.\n\n## Contribute as a frontend developer <a name=\"frontend-contributor\"></a>\n\nAre you a Frontend developer looking to create elegant mobile/web apps which consumes FreeAPIs? Then follow this [Frontend Contribution guide](https://github.com/hiteshchoudhary/apihub/blob/main/CONTRIBUTING_FRONTEND.md) and contribute as a frontend developer\n"
},
{
"path": "CONTRIBUTING_CODE_COVERAGE.md",
"content": "# FreeAPI Testing Contribution Guide\n\nThank you for your interest in contributing to the FreeAPI project to help us deliver our APIs that are battlefield tested. To ensure reliability & stability for our end users, we utilize Playwright, a powerful testing framework to automate testing across all endpoints.\n\n### Why Playwright?\n\nAfter exploring our open-source community options such as Jest, Jasmine & Playwright. We decided to move forward with the playwright as it facilitates automated testing, offers cross-browser support, rich enough API with familiar syntax.\n\n## ⚠️ Important Note:\n\n### Before starting your contribution\n\n- create an issue stating which module you will be working on\n- in a given module if tests exist, we do not welcome them as long as it is a logical fix\n- test coverage for example frontend apps are not our top priority\n\n**IMPORTANT: Contributor must create an issue with [Testing Contribution](https://github.com/hiteshchoudhary/apihub/issues/new?assignees=&labels=testing&projects=&template=code_coverage.yaml&title=TESTING%3A+%3Ctitle%3E) issue template.**\n\nThis ensures coordination and prevents duplicated efforts.\n\n## Table of Contents\n\n1. [🏁 Getting Started](#getting-started)\n2. [👆🏻 Choosing a Module](#choosing-a-module)\n3. [🗂️ Folder Structure](#folder-structure-main)\n4. [📙 Coding Standards](#coding-standards)\n5. [📝 Dependency Management](#dependency-management)\n6. [📨 Submitting Your Contribution](#submitting-your-contribution)\n\n## Getting Started <a name=\"getting-started\"></a>\n\n### Fork the Repository\n\nStart by forking the FreeAPI project repository to your GitHub account.\n\n### Clone Your Fork\n\nClone your fork of the repository to your local machine.\n\n```bash\ngit clone https://github.com/<your_username>/apihub.git\ncd apihub\n```\n\n### Install Dependencies\n\nMake sure you have the necessary dependencies of FreeAPI installed for the frontend framework or library you plan to use.\n\nFollow this [README.md section](https://github.com/hiteshchoudhary/apihub/blob/main/README.md#-installation) to know more about setting up the FreeAPI environment\n\n## Choosing a Module <a name=\"choosing-a-module\"></a>\n\nDecide which module you want to contribute to. Browse the `/apps`, `/public`, or `/kitchen-sink` modules to explore the available modules and APIs. Read the following section carefully to understand the folder structure you need to follow to increase your chances of getting your PR approved.\n\n## Folder Structure <a name=\"folder-structure-main\"></a>\n\nFollow the specified folder structure for your frontend application (**The folder names must not follow the camel casing to keep things consistent.** _Your actual project code folders may have camel casing_):\n\n```\nROOT_FOLDER/e2e/{module}/\n```\n\nSee the following examples with context for the above structure:\n\n## Example: Todo endpoint testing\n\nImagine you want to test the todo endpoint that is part of `/apps` module of the FreeAPI project. To keep a consistent folder structure for backtracking name your files with name identifier, but with an extension of `.test.js`.\n\n### Folder Structure:\n\n```\n$ROOT_FOLDER/e2e/{package}/{module}/{file-indicator}.test.js\n```\n\n## Explanation for the examples:\n\n- `ROOT_FOLDER`: Refers to the root directory of the FreeAPI project.\n\n- `e2e`: This directory is designated for including test cases.\n\n- `{package}`: The directory contains typical of a Node.js application: `app.js` initializes the app, `controllers` handle requests, `models` define data structures, `routes` map endpoints, `utils` provide utilities, and others manage logging, authentication, and database interactions.\n\n- `{module}`: `apps` or `public` or `kitchen-sink`: Denotes the chosen module (`/apps` for complex apps, `/public` for public APIs, `/kitchen-sink` for backend-related static APIs. These folders are already created officially).\n\n- `{file-indicator}`: This is the actual file name indicator that helps to identify for which file you are writing test cases for example: `todo.test.js`\n\nBy following this standardized folder structure, contributors can easily organize their front-end projects, making it convenient for others to explore, understand, and replicate the implementation.\n\n## Coding Standards <a name=\"coding-standards\"></a>\n\nAdhere to the coding standards of the playwright framework. Additionally, consider the following guidelines:\n\n- Use clear descriptive test suite & block names\n- Follow best practices for unit, integration & end-to-end testing\n- Ensure your code is well-documented by comments wherever necessary\n- Make sure to add both positive & negative test cases\n\n## Dependency Management <a name=\"dependency-management\"></a>\n\nIdeally, we do not encourage you to include a new package. Confine your code practices within the available dependencies to avoid overheads. Please state with a clear explanation with examples if you add anything new.\n\n## Submitting Your Contribution <a name=\"submitting-your-contribution\"></a>\n\nClick [here](https://github.com/hiteshchoudhary/apihub/blob/main/CONTRIBUTING.md) for a detailed contribution guide on submitting a PR.\n\nThank you for your contribution to FreeAPI! Your dedication helps make our APIs more accessible and valuable to the community. If you have any questions or need assistance, feel free to reach out to our [Discord](https://hitesh.ai/discord).\n\nThank you for being part of the FreeAPI community and contributing to the project! We look forward to featuring your fantastic work. 🌟\n\nHappy coding! 🚀\n"
},
{
"path": "CONTRIBUTING_FRONTEND.md",
"content": "# FreeAPI Frontend Contribution Guide\n\nThank you for your interest in contributing to the FreeAPI project by creating frontend applications! Your efforts play a crucial role in enhancing the user experience and expanding the reach of our APIs. Please follow this guide to ensure a smooth and collaborative contribution process.\n\n## ⚠️ Important Note:\n\n### Before starting your contribution\n\n- create an issue stating the app you will be working on\n- the technology stack you plan to use\n- the platform you intend to target.\n- describe your application in detail\n\n**IMPORTANT: Contributor must create an issue with [Frontend Contribution](https://github.com/hiteshchoudhary/apihub/issues/new?assignees=&labels=frontend%2Cenhancement&projects=&template=frontend_contribution.yaml&title=FRONTEND%3A+%3Ctitle%3E) issue template.**\n\nThis ensures coordination and prevents duplicated efforts.\n\n## Table of Contents\n\n1. [🏁 Getting Started](#getting-started)\n2. [👆🏻 Choosing a Module](#choosing-a-module)\n3. [🗂️ Folder Structure](#folder-structure-main)\n4. [📙 Coding Standards](#coding-standards)\n5. [📝 Dependency Management](#dependency-management)\n6. [🧪 Testing (optional)](#testing)\n7. [📨 Submitting Your Contribution](#submitting-your-contribution)\n8. [🌟 Featured Projects Opportunity on FreeAPI](#featured-projects)\n9. [🌟 How To Get Featured](#get-featured)\n\n## Getting Started <a name=\"getting-started\"></a>\n\n### Fork the Repository\n\nStart by forking the FreeAPI project repository to your GitHub account.\n\n### Clone Your Fork\n\nClone your fork of the repository to your local machine.\n\n```bash\ngit clone https://github.com/<your_username>/apihub.git\ncd apihub\n```\n\n### Install Dependencies\n\nMake sure you have the necessary dependencies of FreeAPI installed for the frontend framework or library you plan to use.\n\nFollow this [README.md section](https://github.com/hiteshchoudhary/apihub/blob/main/README.md#-installation) to know more about setting up the FreeAPI environment\n\n## Choosing a Module <a name=\"choosing-a-module\"></a>\n\nDecide which module you want to contribute to. Browse the `/apps`, `/public`, or `/kitchen-sink` modules to explore the available modules and APIs. Read the following section carefully to understand the folder structure you need to follow to increase chances to get your PR approved.\n\n## Folder Structure <a name=\"folder-structure-main\"></a>\n\nFollow the specified folder structure for your frontend application (**The folder names must not follow the camel casing to keep things consistent.** _Your actual project code folders may have camel casing_):\n\n```\nROOT_FOLDER/examples/{module}/{app-name}/{platform}/{frontend-tech-used}/{project-code}\n```\n\nSee the following examples with context for above structure:\n\n## Example 1: Social Media Web App\n\nImagine you want to create a web application for the `social-media` project within the `/apps` module of the FreeAPI project. You've decided to use React.js for the frontend, manage state with Redux, and style the app with Tailwind CSS. Your project folder name will be a unique identifier for your application because we are not allowing same application to be built using same tech stack.\n\n### Folder Structure:\n\n```\n$ROOT_FOLDER/examples/apps/social-media/web/react-redux-tailwind/<your_project_folders>\n```\n\n## Example 2: YouTube Mobile App\n\nSuppose you are interested in building a mobile application that consumes the YouTube API from the `/public` folder of the FreeAPI project. For this, you've chosen Flutter as your framework, and you'll be using Riverpod for state management. Again, your project folder name will be a unique identifier for your application because we are not allowing same application to be built using same tech stack.\n\n### Folder Structure:\n\n```bash\n$ROOT_FOLDER/examples/public/youtube/mobile/flutter-riverpod/<your_project_folders>\n```\n\n## Example 3: Status Code Lookup App\n\nYou want to contribute a frontend application to the `/kitchen-sink` module that allows users to input a numerical HTTP status code. The app will then provide details about that status code, such as its purpose and common usage with elegant UI.\n\n## Folder Structure:\n\n```bash\n$ROOT_FOLDER/examples/kitchen-sink/statuscodes/web/react-tailwind/<your_project_folders>\n```\n\n## Explanation for the examples:\n\n- `ROOT_FOLDER:` Refers to the root directory of the FreeAPI project.\n\n- `examples:` This directory is designated for frontend examples.\n\n- `{module} - apps or public or kitchen-sink:` Denotes the chosen module (`/apps` for complex apps, `/public` for public APIs, `/kitchen-sink` for backend-related static APIs. These folders are already created officially).\n\n- `{app_name} - social-media or youtube or statuscode:` Specifies the name of the chosen app or API within the selected module. This folder is also created by default officially.\n\n- `{platform} - web or mobile or desktop:` Defines the platform for which the frontend is developed (web or mobile or desktop etc).\n\n- `{frontend-tech-used} - react-redux-tailwind or flutter-provider:` Indicates the frontend technology stack used, including the framework, UI-lib and state management tool (at least one tech tool name must be there).\n\n- `<your_project_folders>:` Represents the actual project folders that will be coding.\n\nBy following this standardized folder structure, contributors can easily organize their frontend projects, making it convenient for others to explore, understand, and replicate the implementation.\n\n## Coding Standards <a name=\"coding-standards\"></a>\n\nAdhere to the coding standards of the chosen frontend technology and framework. Additionally, consider the following guidelines:\n\n- Use clear and descriptive variable and function names.\n- Follow best practices for state management, component structure, and code organization.\n- Ensure your code is well-documented by comments wherever necessary.\n- Try to use type safe languages like TypeScript over JavaScript to code the frontend\n- **Include comprehensive README.md file for each project on how to do installation and setup for the respective apps**\n\n## Dependency Management <a name=\"dependency-management\"></a>\n\nList all major dependencies/tech tools used in a clear and organized manner in your project README.md. Include version numbers to ensure compatibility.\n\n## Testing (optional) <a name=\"testing\"></a>\n\nWrite tests for your frontend application to ensure its functionality. Include instructions on how to run the tests.\n\n## Submitting Your Contribution <a name=\"submitting-your-contribution\"></a>\n\nClick [here](https://github.com/hiteshchoudhary/apihub/blob/main/CONTRIBUTING.md) for detailed contribution guide on submitting a PR.\n\nThank you for your contribution to FreeAPI! Your dedication helps make our APIs more accessible and valuable to the community. If you have any questions or need assistance, feel free to reach out to our [Discord](https://hitesh.ai/discord).\n\n## 🌟 Featured Projects Opportunity on FreeAPI <a name=\"featured-projects\"></a>\n\nWe value the contributions of our community members, and we want to showcase your work! As part of our effort to highlight the creativity and diversity of the FreeAPI project, we are introducing a Featured Projects section on the official [FreeAPI](https://freeapi.app) site (under development).\n\n## How to Get Featured <a name=\"get-featured\"></a>\n\n1. **Self-Host the FreeAPI Backend:**\n\n - Ensure that you have set up and are self-hosting the FreeAPI backend on your server. Detailed instructions can be found in the [README.md Railway one click deploy section](https://github.com/hiteshchoudhary/apihub/blob/main/README.md#-using-railway-one-click-deploy). _(NOTE: You can deploy this app on server that you are comfortable with. Just make sure it is deployed and your deployed frontend can consume it's apis)_\n\n2. **Consume FreeAPI Backend APIs in Your Frontend:**\n\n - In your frontend project, make sure you are consuming the relevant FreeAPI backend APIs from the deployed backend server. This demonstrates the end-to-end functionality of your application.\n\n3. **Deploy Your Frontend:**\n\n - Deploy your frontend application, and ensure it is accessible via a public URL.\n\n4. **Include Deployed Link in README.md:**\n - Add the deployed link to your frontend application at the top of the README.md file in your project code. This link will serve as the entry point for us to review and feature your project.\n\n### Example README Section:\n\n```markdown\n<!-- other README.md content -->\n<!-- make sure to keep this link at the top to make it visible -->\n\n## Deployed Link\n\nVisit my app: [https://my-social-media-app.example.com](https://my-social-media-app.example.com)\n\n <!-- other README.md content -->\n```\n\n### Why to get featured?\n\n1. **Contribution in Open Source:**\n\n - Gain recognition and celebrate contributions within the FreeAPI community.\n - Enhance your portfolio with real-world open source projects.\n\n2. **Deployed Project:**\n\n - Gain hands-on experience with real-world deployment challenges.\n - Enhance your portfolio with a deployed and functional application.\n\n3. **Showcasing Your Work:**\n\n - Increase visibility by being featured on the official FreeAPI website.\n - Receive recognition from the FreeAPI community.\n\n4. **Networking Opportunities:**\n\n - Connect with like-minded individuals within the FreeAPI community.\n - Showcase your skills to potential collaborators, mentors, or employers.\n\n5. **Beta Stage Advantage:**\n\n - Gain early recognition as an early adopter and contributor.\n - Influence the future development of the Featured Projects feature.\n\n6. **Skill Showcase:**\n\n - Showcase proficiency in both backend consumption and frontend development.\n - Highlight your preferred frontend tech stack.\n\n### What Happens Next:\n\n- **Beta Stage:** While this feature is in beta, our team will be actively monitoring deployed links mentioned in README.md files of frontend example projects.\n\n- **Official Rollout:** Once the Featured Projects page is officially launched on [FreeAPI](https://freeapi.app), we will review and select projects from the submitted links to showcase. So, you can start deploying your apps.\n\n- **Notification:** If your project is selected, we will notify you and include your project in the Featured Projects section on [FreeAPI](https://freeapi.app).\n\n### Important Note:\n\n- Projects with deployed links mentioned at the top of the README.md file have a higher chance of being featured.\n- This feature is in beta, and we appreciate your early contributions to help shape the future of FreeAPI. The more links we get the sooner this section will get up and running.\n\nThank you for being part of the FreeAPI community and contributing to the project! We look forward to featuring your fantastic work. 🌟\n\nHappy coding! 🚀\n"
},
{
"path": "Dockerfile",
"content": "FROM node:20.13.1-alpine\n\nRUN mkdir -p /usr/src/freeapi && chown -R node:node /usr/src/freeapi\n\nWORKDIR /usr/src/freeapi\n\n# Copy package json and yarn lock only to optimise the image building\nCOPY package.json yarn.lock ./\n\n# copy prepare.js prior. It will be executed after package installation and before ROOT dir is cloned\nCOPY prepare.js ./\n\nUSER node\n\nRUN yarn install --pure-lockfile\n\nCOPY --chown=node:node . .\n\nEXPOSE 8080\n\nCMD [ \"npm\", \"start\" ]"
},
{
"path": "LICENSE.md",
"content": "MIT License\n\nFreeAPI\n\nCopyright (c) 2023 Hitesh Choudhary\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
{
"path": "README.md",
"content": "# FreeAPI.app\n\n## Problem\n\nWe are trying to build a single source API hub that can be used to learn api handling in any programming language. Users can build their front end portfolio in web and mobile apps using this api hub.\n\n# What is FreeAPI.app\n\nThe FreeAPI project is an innovative and community-driven initiative aimed at providing developers with free and accessible APIs for their projects.\n\nThe project focuses on delivering a wide range of APIs that cater to various domains and functionalities, enabling developers to seamlessly integrate these APIs into their applications.\n\nKey highlights of the FreeAPI project include:\n\n1. **Accessibility:** The FreeAPI project is committed to eliminating barriers by providing free access to its collection of APIs.\n Developers can leverage these APIs without any cost limitations, allowing them to experiment, learn, and build innovative applications.\n\n2. **Diverse API Collection:** The project offers a diverse and comprehensive collection of APIs that span across different industries, domains, and functionalities.\n Whether you require social media integrations, payment gateways, machine learning algorithms, or IoT device connectivity, the FreeAPI project has you covered.\n\n3. **Simplified Integration:** The FreeAPI project understands the challenges developers face when integrating APIs into their applications. To address this, the project provides clear documentation, code samples, and SDKs, simplifying the integration process and reducing development time and effort.\n\n4. **Community-Driven Development:** The project fosters a vibrant and collaborative community of developers. Contributors are encouraged to share their knowledge, engage in discussions, and collaborate on API-related projects. This collective effort ensures the continuous improvement and reliability of the APIs offered by the FreeAPI project.\n\n5. **Learning and Skill Development:** The FreeAPI project aims to empower developers by providing a platform for learning and skill development. Through access to various APIs and educational resources, developers can enhance their understanding of API integration, expand their knowledge, and showcase their expertise through building complete projects.\n\nOverall, the FreeAPI project is a valuable resource for developers seeking accessible and diverse APIs.\n\nBy fostering a supportive community, the project empowers developers to learn, create, and innovate, ultimately contributing to the growth and advancement of the API integration landscape.\n\n## Features:\n\nIntroducing our groundbreaking open source API hub project, a dynamic platform designed to revolutionize the way developers interact with APIs.\n\nWith an emphasis on openness, accessibility, and learning, our API hub empowers developers of all levels to explore, experiment, and grow their skills in API integration.\n\nHighlights:\n\n1. **Open Source:** Our API hub is built on the principles of open source, ensuring transparency, collaboration, and community-driven development. This means that the source code is freely available, allowing developers to customize, extend, and contribute to the project.\n\n2. **Free to Use:** We firmly believe in removing barriers to entry, which is why our API hub is completely free to use. Whether you're a seasoned developer or just starting your coding journey, you can leverage our platform without any cost limitations.\n\n3. **Local or Deployment**: Flexibility is at the core of our API hub. You have the option to use it locally, running on your own machine, or deploy it to a server, making it accessible to others. This versatility ensures that you can adapt the platform to your specific development environment.\n\n4. **Learning Resource**: Our API hub is designed as a comprehensive learning resource, offering a wealth of educational materials, tutorials, and documentation. Whether you're a beginner or seeking to expand your API knowledge, our platform provides the resources you need to learn and improve.\n\n5. **Custom Endpoints for Beginners**: For developers at the beginner level, our API hub offers custom endpoints that provide a hands-on experience in handling API responses. These beginner-friendly APIs allow you to practice and familiarize yourself with the basics of working with APIs.\n\n6. **Advanced APIs for Portfolio Building**: In addition to beginner-level endpoints, our API hub also provides advanced APIs to challenge and stretch your skills. These APIs enable you to tackle more complex integration scenarios, helping you build a robust portfolio of projects to showcase your expertise.\n\nBy combining open source principles, accessibility, and a focus on learning, our API hub project paves the way for developers to thrive in the world of API integration. Join our vibrant community and embark on an exciting journey of discovery, growth, and innovation.\n\n# ⚠️ Important Note: Avoiding Data Loss and Self-Hosting\n\n# Background:\n\nOur open-source project is currently hosted on a remote server, where we are forced to reset the entire server, **including the file system and MongoDB database**, every **2 hours** to avoid incurring additional costs.\n\nThis process results in the **deletion of all image/static files and a reset of the entire database on the server.**\n\n## What does this mean for you?\n\n**Data Loss:**\nAny changes made during the 2-hour interval (on the remote server), including uploaded images and user data, will be lost and unrecoverable.\n\n**Service Interruption:**\nThe server reset might disrupt your development and testing processes for a certain duration while the server is rebooting (for 1-2 minutes).\n\n## Recommended Solutions:\n\n**Local API Usage:**\nFor development and testing purposes, we strongly recommend using the API locally on your machine by **cloning the project**.\n\nThis ensures that your work is not affected by the server resets and allows you to maintain a stable development environment on your local machine.\n\n**Self-Hosting on Railway _(recommended for personal projects)_:**\nTo self-host the FreeAPI.app application, you can take advantage of a pre-built template that is readily available.\n[Click here for detailed docs](https://github.com/hiteshchoudhary/apihub/#-using-railway-one-click-deploy)\n\n# 🏁 Installation\n\n### 📦 Using Docker (recommended)\n\nTo run the FreeAPI project, follow these steps:\n\n1. Install [Docker](https://www.docker.com/) on your machine.\n2. Clone the project repository.\n3. Navigate to the project directory.\n4. Create `.env` file in the root folder and copy paste the content of `.env.sample`, and add necessary credentials.\n5. Run the Docker Compose command:\n\n```bash\ndocker-compose up --build --attach backend\n\n# --build: Rebuild the image and run the containers\n# --attach: only show logs of Node app container and not mongodb\n```\n\n6. Access the project APIs at the specified endpoints.\n\n### 💻 Running locally\n\nTo run the FreeAPI project locally, follow these steps:\n\n1. Install [Yarn](https://yarnpkg.com/), [NodeJs](https://www.nodejs.org/), [MongoDB](https://www.mongodb.com) and [MongoDB Compass (optional)](https://www.mongodb.com/products/compass) on your machine.\n2. Clone the project repository.\n3. Navigate to the project directory.\n4. Create `.env` file in the root folder and copy paste the content of `.env.sample`, and add necessary credentials.\n5. Install the packages:\n\n```bash\nyarn install\n```\n\n6. Run the project:\n\n```bash\nyarn start\n```\n\n7. Access the project APIs at the specified endpoints.\n\n### 🚄 Using Railway (One-click Deploy)\n\nTo self-host the FreeAPI.app application, you can take advantage of a pre-built template that is readily available.\n\n[](https://railway.app/template/B2f7Hq)\n\n1. Click the button above to visit railway.app.\n\n2. Click on the **Deploy Now** button.\n\n3. (Optional) Sign in with GitHub to deploy.\n\n4. Fill in the Repository details:\n\n - Specify the repo name (e.g., freeapi-app).\n - Checkmark for Public/Private repository.\n\n5. For Environment variables, we have provided some default values in the `ENV` to reduce the burden, but some parameters are mandatory:\n\n - `PORT`: Do not change the value, let it be set to 8080 to view the swagger docs after deployment.\n - `MONGODB_URI`: Provide the MongoDB Atlas database URL. An example is prefilled for you, edit/update it to continue.\n - `NODE_ENV`: Default set to 'development' to view the logs. You may choose to change it to 'production' (make sure to add exact same word) to hide them.\n - `EXPRESS_SESSION_SECRET`: It is advised to change the default value to your own secret value.\n - `ACCESS_TOKEN_SECRET`: It is advised to change the default value to your own secret value.\n - `ACCESS_TOKEN_EXPIRY`: Set to 1 day as default.\n - `REFRESH_TOKEN_SECRET`: It is advised to change the default value to your own secret value.\n - `REFRESH_TOKEN_EXPIRY`: Set to 10 days as default.\n - `FREEAPI_HOST_URL`: Set it as generated railway url.\n\n6. Once you fill in the required environment parameters, if you choose to add others such as PayPal, Google, and Razorpay, please proceed to mention your credentials in the form.\n\n7. Click on the **Deploy** button to trigger the first build.\n - Monitor the server logs; if you come across any deployment problems, feel free to raise an issue for our team to look into.\n\nNote: Once the application is deployed, please wait for 3-5 minutes for the swagger docs to be available.\n\n# 🧪 Testing\n\nTo ensure reliability & stability for our end users, we utilize Playwright, a powerful testing framework to automate testing across all endpoints.\n\n### 💻 Run the Test Server\n\nMake sure to add `MONGO_MEMORY_SERVER_PORT=10000` (mongodb port for e2e testing) in your `.env` file.\n\n```bash\nyarn start:test-server\n```\n\n### 🧪 Run Tests\n\n```bash\nyarn test:playwright\n```\n\nThis will generate a Playwright report. To view this report run the following command\n\n```bash\nyarn playwright show-report\n```\n\nMake sure all the test cases are passed whenever you make any changes.\n\n# How to contribute - Guidelines\n\n## ⚡️ Contribute in core FreeAPI codebase:\n\nWe welcome your interest in contributing to our open source project!\n\nTo contribute to FreeAPI, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bug fix: `git checkout -b feat/your-feature-name` or `git checkout -b fix/your-bug-fix-name` and make your changes.\n3. Run all the tests 🧪 before committing the changes and make sure all tests are passed.\n4. After all tests are passed, commit your changes with a descriptive messages: `git commit -am 'add your commit message'`\n5. For more details on the commit format and other guidelines, please refer to the [Contributor Guidelines](./CONTRIBUTING.md).\n6. Push your changes to your forked repository: `git push origin feat/your-feature-name`.\n7. Submit a pull request to the main repository, explaining the changes you've made and providing any necessary details.\n\nHere's a guide on how you can effectively contribute to our API hub:\n\n1. Pull Requests for Readme Updates: Please refrain from sending pull requests solely for updating the project's readme file. While we appreciate the importance of clear and concise documentation, we prefer to focus on substantial code contributions and feature enhancements.\n\n2. Grammar Updates: Our team values effective communication, but we're not grammar sticklers. You don't need to send pull requests solely for grammar fixes or minor language improvements. Instead, concentrate on the core functionalities and features of the project.\n\n3. Avoid Updating Existing Public APIs: To maintain stability and consistency, we discourage direct updates to existing public APIs within the API hub. These APIs have been thoroughly tested and approved. However, if you encounter any bugs or issues, we encourage you to open an issue on our project's issue tracker to notify us.\n\n4. Build New Project APIs: We encourage you to explore your creativity and contribute by building complete project APIs. These APIs should provide comprehensive solutions that can assist developers in constructing complex projects to showcase their skills and abilities. Your contributions in this area will greatly benefit the community.\n\n5. Draft a Proposal and Discuss on Discord: Before diving into your project, we recommend drafting a proposal. This can include a mind map or outline of the API you intend to build and its potential benefits. Join our Discord community, where you can share your proposal, discuss ideas, and gather feedback from fellow contributors. Engaging in these discussions will enhance your backend portfolio and help shape the future direction of the project.\n\nWe appreciate your enthusiasm and look forward to your valuable contributions to our open source API hub project.\n\nTogether, we can foster a collaborative environment and make a significant impact in the API integration landscape.\n\nClick [here](https://github.com/hiteshchoudhary/apihub/blob/main/CONTRIBUTING.md) for detailed contribution guide.\n\n## 🚀 Contribute by creating frontend application:\n\nThank you for your interest in contributing to the FreeAPI project by creating frontend applications consuming FreeAPIs! Your efforts play a crucial role in enhancing the user experience and expanding the reach of our APIs. Please follow this guide to ensure a smooth and collaborative contribution process.\n\nClick [here](https://github.com/hiteshchoudhary/apihub/blob/main/CONTRIBUTING_FRONTEND.md) for detailed contribution guide for Frontend Developers 🚀!\n\n## 🧪 Contribute in testing suite\n\nThank you for your interest in contributing to the FreeAPI project to increase code coverage of our API service that helps us to ship robust endpoints that are battlefield tested. Please follow this guide to ensure a smooth and collaborative contribution process.\n\nClick [here](https://github.com/hiteshchoudhary/apihub/blob/main/CONTRIBUTING_CODE_COVERAGE.md) for detailed contribution guide for increasing code coverage.\n\n# 📜 Swagger Docs\n\n[Swagger Docs](https://api.freeapi.app): https://api.freeapi.app\n\nNOTE: Swagger docs are auto generated from the `swagger.yaml` file. While running the project locally, make sure you change the url to `http://localhost:<port_from_.env>/api/v1` in the swagger docs `servers/url` field.\n"
},
{
"path": "docker-compose.prod.yml",
"content": "version: '3.8'\n\nservices:\n backend:\n image: freeapi-server\n build: .\n ports:\n - 8080:8080\n volumes:\n - ./:/usr/src/freeapi\n - /usr/src/freeapi/node_modules\n env_file:\n - ./.env\n depends_on:\n - mongodb\n networks:\n - freeapi-internal\n \n mongodb:\n image: mongo\n container_name: mongodb\n volumes:\n - data:/data/db\n networks:\n - freeapi-internal\n\nnetworks:\n freeapi-internal:\n\nvolumes:\n data:\n"
},
{
"path": "docker-compose.yml",
"content": "version: '3.8'\n\nservices:\n backend:\n image: freeapi-server\n build: .\n ports:\n - 8080:8080\n volumes:\n - ./:/usr/src/freeapi\n - /usr/src/freeapi/node_modules\n env_file:\n - ./.env\n depends_on:\n - mongodb\n mongodb:\n image: mongo\n container_name: mongodb\n volumes:\n - data:/data/db\n ports:\n - 27017:27017\n\nvolumes:\n data:"
},
{
"path": "e2e/common.js",
"content": "import dotenv from \"dotenv\";\n\ndotenv.config({\n path: \"../.env\",\n});\n\nexport const URL = `http://localhost:${process.env.PORT || 8080}`;\n\nexport const getApiContext = async (playwright) =>\n playwright.request.newContext({\n baseURL: URL,\n });\n"
},
{
"path": "e2e/db.js",
"content": "import mongoose, { mongo } from \"mongoose\";\nimport { MongoMemoryServer } from \"mongodb-memory-server\";\n\nconst MONGO_MEMORY_SERVER_PORT = process.env.MONGO_MEMORY_SERVER_PORT || 10000;\nconst MONGODB_URL = `mongodb://127.0.0.1:${MONGO_MEMORY_SERVER_PORT}/`;\n\nlet mongoServer = null;\nlet dbInstance = undefined;\n\nconst connectDB = async () => {\n try {\n await mongoose.disconnect();\n mongoServer = await MongoMemoryServer.create({\n instance: {\n port: +MONGO_MEMORY_SERVER_PORT,\n },\n });\n dbInstance = await mongoose.connect(MONGODB_URL);\n } catch (error) {\n console.error(\"Mongo db connect error: \", error);\n process.exit(1);\n }\n};\nexport const clearDB = async (collectionName = null) => {\n if (!dbInstance) {\n dbInstance = await mongoose.connect(MONGODB_URL);\n }\n const connection = mongoose.connection;\n if (collectionName) {\n await connection.db.collection(collectionName).deleteMany({});\n } else {\n const collections = await connection.db.listCollections().toArray();\n const collectionNames = collections.map((col) => col.name);\n for (let name of collectionNames) {\n await connection.db.collection(name).deleteMany({});\n }\n }\n};\n\nexport default connectDB;\n"
},
{
"path": "e2e/routes/apps/todo.test.js",
"content": "import { test, expect } from \"@playwright/test\";\nimport { getApiContext } from \"../../common.js\";\nimport { clearDB } from \"../../db.js\";\nlet apiContext;\n\nlet todoId = null;\n\ntest.describe(\"Todo App\", () => {\n test.beforeAll(async ({ playwright }) => {\n apiContext = await getApiContext(playwright);\n await clearDB();\n });\n test.afterAll(async ({}) => {\n await apiContext.dispose();\n });\n\n test.describe(\"GET:/api/v1/todos - Get All Todos\", () => {\n test(\"should return all todos\", async () => {\n const res = await apiContext.get(`/api/v1/todos`);\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.length).toEqual(0);\n });\n });\n\n test.describe(\"POST:/api/v1/todos - Create Todo\", () => {\n test(\"should create todo with valid data\", async () => {\n const todo = {\n title: \"test-todo-title\",\n description: \"test-todo-description\",\n };\n const res = await apiContext.post(`/api/v1/todos`, {\n data: todo,\n });\n const json = await res.json();\n expect(res.status()).toEqual(201);\n expect(json.statusCode).toEqual(201);\n expect(json.data).toMatchObject(todo);\n todoId = json.data._id;\n });\n\n test(\"should return a 422 with title error when `title` is not provided\", async () => {\n const todo = {};\n const res = await apiContext.post(`/api/v1/todos`, {\n data: todo,\n });\n const json = await res.json();\n expect(res.status()).toEqual(422);\n expect(json.statusCode).toEqual(422);\n expect(json.errors).toContainEqual(\n expect.objectContaining({ title: expect.anything() })\n );\n });\n\n test(\"should return a 422 with title and description error when `title` and `description` is empty\", async () => {\n const todo = { title: \"\", description: \"\" };\n const res = await apiContext.post(`/api/v1/todos`, {\n data: todo,\n });\n const json = await res.json();\n expect(res.status()).toEqual(422);\n expect(json.statusCode).toEqual(422);\n expect(json.errors).toContainEqual(\n expect.objectContaining({ title: expect.anything() })\n );\n expect(json.errors).toContainEqual(\n expect.objectContaining({ description: expect.anything() })\n );\n });\n });\n\n test.describe(\"PATCH:/api/v1/todos/:id - Update Todo\", () => {\n const todo = {\n title: \"update-test-todo-title\",\n description: \"update-test-todo-description\",\n };\n\n test(\"should update todo with valid data\", async () => {\n const res = await apiContext.patch(`/api/v1/todos/${todoId}`, {\n data: todo,\n });\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.statusCode).toEqual(200);\n expect(json.data).toMatchObject(todo);\n });\n\n test(\"should return a 422 with title and description error when `title` and `description` is empty\", async () => {\n const todo = { title: \"\", description: \"\" };\n const res = await apiContext.patch(`/api/v1/todos/${todoId}`, {\n data: todo,\n });\n const json = await res.json();\n expect(res.status()).toEqual(422);\n expect(json.statusCode).toEqual(422);\n expect(json.errors).toContainEqual(\n expect.objectContaining({ title: expect.anything() })\n );\n expect(json.errors).toContainEqual(\n expect.objectContaining({ description: expect.anything() })\n );\n });\n });\n\n test.describe(\"PATCH:/api/v1/todos/toggle/status/:id - Toggle todo status\", () => {\n test(\"should toggle todo status\", async () => {\n const res = await apiContext.patch(\n `/api/v1/todos/toggle/status/${todoId}`\n );\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.statusCode).toEqual(res.status());\n expect(json.data.isComplete).toBeTruthy();\n });\n });\n\n test.describe(\"GET:/api/v1/todos - Get All Todos\", () => {\n test(\"should return todo when valid id passed\", async () => {\n const res = await apiContext.get(`/api/v1/todos/${todoId}`);\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.statusCode).toEqual(res.status());\n });\n\n test(\"should return 422 with todoId error when invalid id passed\", async () => {\n const res = await apiContext.get(`/api/v1/todos/__1`);\n const json = await res.json();\n expect(res.status()).toEqual(422);\n expect(json.statusCode).toEqual(res.status());\n expect(json.errors).toContainEqual(\n expect.objectContaining({ todoId: expect.anything() })\n );\n });\n });\n\n test.describe(\"DELETE:/api/v1/todos/:id - Delete Todo\", () => {\n test(\"should delete todo\", async () => {\n const res = await apiContext.delete(`/api/v1/todos/${todoId}`);\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.statusCode).toEqual(res.status());\n });\n });\n});\n"
},
{
"path": "e2e/routes/healthcheck.test.js",
"content": "import { test, expect } from \"@playwright/test\";\nimport { getApiContext } from \"../common.js\";\n\nlet apiContext;\n\ntest.describe(\"Healthcheck\", () => {\n test.beforeAll(async ({ playwright }) => {\n apiContext = await getApiContext(playwright);\n });\n test.afterAll(async ({}) => {\n await apiContext.dispose();\n });\n\n test(\"should return ok\", async ({ page }) => {\n const res = await apiContext.get(\"/api/v1/healthcheck\");\n expect(res.ok()).toBeTruthy();\n });\n});\n"
},
{
"path": "e2e/routes/seeds/chat-app.test.js",
"content": "import { test, expect } from \"@playwright/test\";\nimport { getApiContext } from \"../../common.js\";\nimport { clearDB } from \"../../db.js\";\n\nlet apiContext;\n\ntest.describe(\"Seed Chat App\", () => {\n test.beforeAll(async ({ playwright }) => {\n apiContext = await getApiContext(playwright);\n await clearDB();\n });\n test.afterAll(async ({}) => {\n await apiContext.dispose();\n });\n\n test.describe(\"POST:/api/v1/seed/chat-app - Seed Chat\", async () => {\n test(\"should seed Chat App DB\", async ({ page }) => {\n const res = await apiContext.post(\"/api/v1/seed/chat-app\");\n expect(res.status()).toEqual(201);\n });\n });\n});\n"
},
{
"path": "e2e/routes/seeds/ecommerce.test.js",
"content": "import { test, expect } from \"@playwright/test\";\nimport { getApiContext } from \"../../common.js\";\nimport { clearDB } from \"../../db.js\";\nimport {\n CATEGORIES_COUNT,\n PRODUCTS_COUNT,\n} from \"../../../src/seeds/_constants.js\";\n\nlet apiContext;\n\ntest.describe(\"Seed Ecommerce App\", () => {\n test.beforeAll(async ({ playwright }) => {\n apiContext = await getApiContext(playwright);\n await clearDB();\n });\n test.afterAll(async ({}) => {\n await apiContext.dispose();\n });\n\n test.describe(\"POST:/api/v1/seed/ecommerce - Seed Ecommerce\", async () => {\n test(\"should return 0 products before seed\", async ({ page }) => {\n const res = await apiContext.get(\n \"/api/v1/ecommerce/products?page=1&limit=1\"\n );\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.totalProducts).toEqual(0);\n });\n test(\"should return 0 categories before seed\", async ({ page }) => {\n const res = await apiContext.get(\n \"/api/v1/ecommerce/categories?page=1&limit=1\"\n );\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.totalCategories).toEqual(0);\n });\n test(\"should seed ecommerce DB\", async ({ page }) => {\n const res = await apiContext.post(\"/api/v1/seed/ecommerce\");\n expect(res.status()).toEqual(201);\n });\n test(`should return ${PRODUCTS_COUNT} products after seed`, async ({\n page,\n }) => {\n const res = await apiContext.get(\n \"/api/v1/ecommerce/products?page=1&limit=1\"\n );\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.totalProducts).toEqual(PRODUCTS_COUNT);\n });\n test(`should return ${CATEGORIES_COUNT} categories after seed`, async ({\n page,\n }) => {\n const res = await apiContext.get(\n \"/api/v1/ecommerce/categories?page=1&limit=1\"\n );\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.totalCategories).toEqual(CATEGORIES_COUNT);\n });\n });\n});\n"
},
{
"path": "e2e/routes/seeds/generated-credentials.test.js",
"content": "import fs from \"fs\";\nimport { test, expect } from \"@playwright/test\";\nimport { getApiContext } from \"../../common.js\";\n\nlet apiContext;\n\ntest.describe(\"Get credentials\", () => {\n test.beforeAll(async ({ playwright }) => {\n apiContext = await getApiContext(playwright);\n });\n test.afterAll(async ({}) => {\n await apiContext.dispose();\n });\n\n test.describe(\"GET:/api/v1/seed/generated-credentials - Get credentials\", async () => {\n test(\"should return public/temp/seed-credentials.json content\", async ({\n page,\n }) => {\n const seedCredentialsText = fs.readFileSync(\n \"./public/temp/seed-credentials.json\",\n \"utf8\"\n );\n const seedCredentials = JSON.parse(seedCredentialsText);\n const res = await apiContext.get(\"/api/v1/seed/generated-credentials\");\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data).toMatchObject(seedCredentials);\n });\n });\n});\n"
},
{
"path": "e2e/routes/seeds/social-media.test.js",
"content": "import { test, expect } from \"@playwright/test\";\nimport { getApiContext } from \"../../common.js\";\nimport { clearDB } from \"../../db.js\";\nimport { SOCIAL_POSTS_COUNT } from \"../../../src/seeds/_constants.js\";\n\nlet apiContext;\n\ntest.describe(\"Seed social-media App\", () => {\n test.beforeAll(async ({ playwright }) => {\n apiContext = await getApiContext(playwright);\n await clearDB();\n });\n test.afterAll(async ({}) => {\n await apiContext.dispose();\n });\n\n test.describe(\"POST:/api/v1/seed/social-media - Seed social-media\", async () => {\n test(\"should return 0 posts before seed\", async ({ page }) => {\n const res = await apiContext.get(\n \"/api/v1/social-media/posts?page=1&limit=1\"\n );\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.totalPosts).toEqual(0);\n });\n test(\"should seed social-media DB\", async ({ page }) => {\n const res = await apiContext.post(\"/api/v1/seed/social-media\");\n expect(res.status()).toEqual(201);\n });\n test(`should return ${SOCIAL_POSTS_COUNT} post after seed`, async ({\n page,\n }) => {\n const res = await apiContext.get(\n \"/api/v1/social-media/posts?page=1&limit=1\"\n );\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.totalPosts).toEqual(SOCIAL_POSTS_COUNT);\n });\n });\n});\n"
},
{
"path": "e2e/routes/seeds/todo.test.js",
"content": "import { test, expect } from \"@playwright/test\";\nimport { getApiContext } from \"../../common.js\";\nimport { clearDB } from \"../../db.js\";\nimport { TODOS_COUNT } from \"../../../src/seeds/_constants.js\";\n\nlet apiContext;\n\ntest.describe(\"Seed Todo App\", () => {\n test.beforeAll(async ({ playwright }) => {\n apiContext = await getApiContext(playwright);\n await clearDB();\n });\n test.afterAll(async ({}) => {\n await apiContext.dispose();\n });\n\n test.describe(\"POST:/api/v1/seed/todos - Seed Todos\", async () => {\n test(\"should return 0 todos before seed\", async ({ page }) => {\n const res = await apiContext.get(\"/api/v1/todos\");\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.length).toEqual(0);\n });\n\n test(\"should seed todo DB\", async ({ page }) => {\n const res = await apiContext.post(\"/api/v1/seed/todos\");\n expect(res.status()).toEqual(201);\n });\n\n test(`should return ${TODOS_COUNT} todos after seed`, async ({ page }) => {\n const res = await apiContext.get(\"/api/v1/todos\");\n const json = await res.json();\n expect(res.status()).toEqual(200);\n expect(json.data.length).toEqual(TODOS_COUNT);\n });\n });\n});\n"
},
{
"path": "e2e/test-server.js",
"content": "import dotenv from \"dotenv\";\ndotenv.config({\n path: \"../.env\",\n});\nimport { httpServer } from \"../src/app.js\";\nimport connectDB from \"./db.js\";\n\nconst PORT = process.env.PORT || 8080;\n\n/**\n * Starting from Node.js v14 top-level await is available and it is only available in ES modules.\n * This means you can not use it with common js modules or Node version < 14.\n */\nconst majorNodeVersion = +process.env.NODE_VERSION?.split(\".\")[0] || 0;\n\nconst startServer = () => {\n httpServer.listen(PORT, () => {\n console.info(`📑 Visit the documentation at: http://localhost:${PORT}`);\n console.log(\"⚙️ Server is running on port: \" + PORT);\n });\n};\n\nif (majorNodeVersion >= 14) {\n try {\n await connectDB();\n startServer();\n } catch (err) {\n console.log(\"Mongo db connect error: \", err);\n }\n} else {\n connectDB()\n .then(() => {\n startServer();\n })\n .catch((err) => {\n console.log(\"Mongo db connect error: \", err);\n });\n}\n"
},
{
"path": "examples/apps/auth/.gitkeep",
"content": ""
},
{
"path": "examples/apps/chat-app/web/react-vite-tailwind/.eslintrc.cjs",
"content": "module.exports = {\n root: true,\n env: { browser: true, es2020: true },\n extends: [\n \"eslint:recommended\",\n \"plugin:@typescript-eslint/recommended\",\n \"plugin:react-hooks/recommended\",\n ],\n ignorePatterns: [\"dist\", \".eslintrc.cjs\"],\n parser: \"@typescript-eslint/parser\",\n plugins: [\"react-refresh\"],\n rules: {\n \"react-refresh/only-export-components\": [\n \"warn\",\n { allowConstantExport: true },\n ],\n \"@typescript-eslint/no-explicit-any\": [\"off\"],\n },\n};\n"
},
{
"path": "examples/apps/chat-app/web/react-vite-tailwind/.gitignore",
"content": "# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\npnpm-debug.log*\nlerna-debug.log*\n\nnode_modules\ndist\ndist-ssr\n*.local\n\n# Editor directories and files\n.vscode/*\n!.vscode/extensions.json\n.idea\n.DS_Store\n*.suo\n*.ntvs*\n*.njsproj\n*.sln\n*.sw?"
},
{
"path": "examples/apps/chat-app/web/react-vite-tailwind/README.md",
"content": "# Installation and setup\n\nCreate a `.env` file in the ROOT folder and copy past the content of the `.env.sample` file in it.\n\nRun the following commands to start the server\n\n```bash\nnpm install\nnpm run dev\n\n# Make sure to keep the freeapi server running\n```\n"
},
{
"path": "examples/apps/chat-app/web/react-vite-tailwind/index.html",
"content": "<!doctype html>\n<html lang=\"en\">\n <head>\n <meta charset=\"UTF-8\" />\n <link rel=\"icon\" type=\"image/svg+xml\" href=\"/vite.svg\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n <title>FreeAPI | Chat app example\n \n \n \n \n \n