├── .dockerignore ├── .env.example ├── .eslintignore ├── .eslintrc.cjs ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── add-devtip.yml │ ├── bug.yaml │ ├── doc_issue.yaml │ ├── feature_request.yml │ └── other.yaml ├── PULL_REQUEST_TEMPLATE.md └── workflows │ ├── greetings.yml │ ├── lint-testing.yml │ ├── post-devtip.yml │ ├── prettier.yml │ ├── publish-dockerhub.yml │ ├── publish-ghcr.yml │ └── releases.yml ├── .gitignore ├── .gitpod.Dockerfile ├── .gitpod.yml ├── .husky └── pre-commit ├── .prettierignore ├── .prettierrc ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── Dockerfile ├── LICENSE ├── README.md ├── SECURITY.md ├── config └── config.js ├── controller └── devtip │ ├── deleteDevTip.js │ ├── getDevTip.js │ ├── getDevTipById.js │ ├── postDevTip.js │ └── updateDevTip.js ├── docker-compose.yaml ├── index.js ├── middleware ├── 404.js └── logger.js ├── models └── devTipSchema.js ├── package-lock.json ├── package.json ├── public ├── index.html └── style.css ├── routes └── devTipRouter.js ├── test └── devtips │ ├── deleteDevTip.test.js │ ├── getDevTip.test.js │ ├── getDevTipByID.test.js │ ├── hopepage.test.js │ ├── postDevTip.test.js │ └── updateDevTip.test.js └── vercel.json /.dockerignore: -------------------------------------------------------------------------------- 1 | .git 2 | .env 3 | LICENSE 4 | .gitignore 5 | Dockerfile 6 | node_modules 7 | docker-compose.* 8 | CHANGELOG.md 9 | vercel.json 10 | CODE_OF_CONDUCT.md 11 | README.md 12 | .gitpod.yml 13 | .github -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | PORT=9009 2 | MONGODB_URL=mongodb://localhost:27017 3 | DB_NAME=opensourceapi 4 | COLLECTION_NAME=devtip 5 | TEST_DEV_TIP_ID=6496d41f4d74cf02e5c86d4f -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | test 2 | config -------------------------------------------------------------------------------- /.eslintrc.cjs: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | env: { 3 | browser: true, 4 | es2021: true, 5 | }, 6 | extends: "eslint:recommended", 7 | overrides: [ 8 | { 9 | env: { 10 | node: true, 11 | }, 12 | files: [".eslintrc.{js,cjs}"], 13 | parserOptions: { 14 | sourceType: "script", 15 | }, 16 | }, 17 | ], 18 | parserOptions: { 19 | ecmaVersion: "latest", 20 | sourceType: "module", 21 | }, 22 | rules: {}, 23 | }; 24 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [Pradumnasaraf] 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/add-devtip.yml: -------------------------------------------------------------------------------- 1 | name: Add a new Developer Tip 2 | title: New Developer Tip 3 | description: Include your Tip to the OpenSource API database. 4 | labels: ["dev-tip"] 5 | body: 6 | - type: textarea 7 | id: message 8 | attributes: 9 | label: Developer Tip 10 | description: Enter your tip here. 11 | validations: 12 | required: true 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug.yaml: -------------------------------------------------------------------------------- 1 | name: 🐛 Bug 2 | description: Report an issue to help improve the project. 3 | title: "[BUG] " 4 | labels: ["bug"] 5 | body: 6 | - type: textarea 7 | id: description 8 | attributes: 9 | label: Description 10 | description: A brief description of the question or issue, also include what you tried and what didn't work 11 | validations: 12 | required: true 13 | - type: textarea 14 | id: screenshots 15 | attributes: 16 | label: Screenshots 17 | description: Please add screenshots if applicable 18 | validations: 19 | required: false 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/doc_issue.yaml: -------------------------------------------------------------------------------- 1 | name: 📄 Documentation issue 2 | description: Found an issue in the documentation? You can use this one! 3 | title: "[DOCS] " 4 | labels: ["documentation"] 5 | body: 6 | - type: textarea 7 | id: description 8 | attributes: 9 | label: Description 10 | description: Description of the question or issue, also include what you tried and what didn't work 11 | validations: 12 | required: true 13 | - type: textarea 14 | id: screenshots 15 | attributes: 16 | label: Screenshots 17 | description: Screenshots if applicable 18 | validations: 19 | required: false 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: 💡 General Feature Request 2 | description: Have a new idea/feature? Please suggest! 3 | title: "[FEATURE] " 4 | labels: ["feature"] 5 | body: 6 | - type: textarea 7 | id: description 8 | attributes: 9 | label: Description 10 | description: Description of the enhancement you propose, also include what you tried and what worked. 11 | validations: 12 | required: true 13 | - type: textarea 14 | id: screenshots 15 | attributes: 16 | label: Screenshots 17 | description: Screenshots if applicable 18 | validations: 19 | required: false 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/other.yaml: -------------------------------------------------------------------------------- 1 | name: ❗ Other 2 | description: Use this for any other issues. Please do NOT create blank issues 3 | title: "[OTHER] " 4 | labels: ["other"] 5 | body: 6 | - type: textarea 7 | id: issuedescription 8 | attributes: 9 | label: What would you like to share? 10 | description: Provide a clear and concise explanation of your issue. 11 | validations: 12 | required: true 13 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## 🛠️ Fixes Issue 4 | 5 | 6 | 7 | 8 | 9 | ## 👨‍💻 Changes proposed 10 | 11 | 12 | 13 | ## ✔️ Check List (Check all the applicable boxes) 14 | 15 | 16 | 20 | 21 | - [ ] My code follows the code style of this project. 22 | - [ ] This PR does not contain plagiarized content. 23 | - [ ] The title of my pull request is a short description of the requested changes. 24 | 25 | ## 📄 Note to reviewers 26 | 27 | 28 | 29 | ## 📷 Screenshots 30 | -------------------------------------------------------------------------------- /.github/workflows/greetings.yml: -------------------------------------------------------------------------------- 1 | name: Greeting message 2 | on: 3 | fork: 4 | issues: 5 | types: [opened] 6 | pull_request_target: 7 | types: [opened] 8 | 9 | jobs: 10 | welcome: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v1 14 | - uses: EddieHubCommunity/gh-action-community/src/welcome@main 15 | with: 16 | github-token: ${{ secrets.GITHUB_TOKEN }} 17 | issue-message: "

Hey! contributor, thank you for opening an Issue 🎉.

" 18 | pr-message: "

Hey! contributor, thank you for opening a Pull Request 🎉.

" 19 | footer: "Soon one of our maintainers will review it and provide you with feedback/suggestions. If you think it's something urgent, feel free to reach out Pradumna Saraf on Twitter. Star ⭐ this repo to show us support.

Happy, Open Source!" 20 | -------------------------------------------------------------------------------- /.github/workflows/lint-testing.yml: -------------------------------------------------------------------------------- 1 | name: Unit Tests + Lint 2 | 3 | on: 4 | workflow_dispatch: 5 | push: 6 | paths: 7 | - "**.js" 8 | pull_request: 9 | paths: 10 | - "**.js" 11 | 12 | jobs: 13 | tests: 14 | runs-on: ubuntu-latest 15 | services: 16 | mongo: 17 | image: mongo 18 | ports: 19 | - 27017:27017 20 | steps: 21 | - name: Checking and cloning the repo 22 | uses: actions/checkout@v3 23 | 24 | - name: Copying the env file 25 | run: npm run env 26 | 27 | - name: Node Instllation 28 | uses: actions/setup-node@v3 29 | with: 30 | node-version: "18" 31 | 32 | - name: Install dependencies 33 | run: npm ci 34 | 35 | - name: Run lint 36 | run: npm run lint 37 | 38 | - name: Run tests 39 | run: npm test 40 | -------------------------------------------------------------------------------- /.github/workflows/post-devtip.yml: -------------------------------------------------------------------------------- 1 | name: Post Request to API 2 | 3 | on: 4 | issues: 5 | types: [opened, edited] 6 | 7 | jobs: 8 | post-devtip: 9 | name: Add data to DB via POST Request 10 | if: contains(github.event.issue.labels.*.name, 'dev-tip') 11 | runs-on: ubuntu-latest 12 | 13 | steps: 14 | - name: Cloning the repo 15 | uses: actions/checkout@v3 16 | 17 | - name: Getting data from Issue Form 18 | uses: stefanbuck/github-issue-parser@v3 19 | id: issue-parser 20 | with: 21 | template-path: .github/ISSUE_TEMPLATE/add-devtip.yml 22 | 23 | - name: Sending a POST Request to API 24 | uses: fjogeleit/http-request-action@v1 25 | id: myRequest 26 | with: 27 | url: ${{ vars.API_URL }} 28 | method: "POST" 29 | customHeaders: '{"Content-Type": "application/json"}' 30 | data: '{"message": "${{ steps.issue-parser.outputs.issueparser_message }}"}' 31 | 32 | - name: Printing out the response 33 | run: | 34 | echo ${{ fromJson(steps.myRequest.outputs.response).status }} 35 | echo "With ID: ${{ fromJson(steps.myRequest.outputs.response).data.devtip._id }}" 36 | 37 | - name: Closing the Issue 38 | uses: YiiGuxing/close-issue@v2.1.0 39 | with: 40 | comment: | 41 | Hey, your **Dev Tip** has been added with the ID `_id: ${{ fromJson(steps.myRequest.outputs.response).data.devtip._id }}`. 42 | -------------------------------------------------------------------------------- /.github/workflows/prettier.yml: -------------------------------------------------------------------------------- 1 | name: Format 2 | on: [push, workflow_dispatch, pull_request] 3 | 4 | jobs: 5 | format: 6 | runs-on: ubuntu-latest 7 | name: Format Files 8 | steps: 9 | - uses: actions/checkout@v3 10 | - uses: actions/setup-node@v3 11 | with: 12 | node-version: "18" 13 | - run: npm ci 14 | - name: Prettier 15 | run: npm run format 16 | env: 17 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 18 | - uses: stefanzweifel/git-auto-commit-action@v4 19 | if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }} 20 | with: 21 | commit_message: "style: format files" 22 | -------------------------------------------------------------------------------- /.github/workflows/publish-dockerhub.yml: -------------------------------------------------------------------------------- 1 | name: Publish Image to DockerHub 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | build: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - uses: actions/checkout@v3 13 | 14 | - name: get-npm-version 15 | id: package-version 16 | uses: martinbeentjes/npm-get-version-action@v1.3.1 17 | 18 | - name: DockerHub Login 19 | uses: docker/login-action@v2.1.0 20 | with: 21 | username: ${{ secrets.DOCKERHUB_USERNAME }} 22 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 23 | 24 | - name: Build the Docker image 25 | run: docker build . --file Dockerfile --tag ${{ secrets.DOCKERHUB_USERNAME }}/opensource-api:${{ steps.package-version.outputs.current-version}} 26 | 27 | - name: Docker Push 28 | run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/opensource-api:${{ steps.package-version.outputs.current-version}} 29 | -------------------------------------------------------------------------------- /.github/workflows/publish-ghcr.yml: -------------------------------------------------------------------------------- 1 | name: Publish Image - GHCR 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | env: 8 | REGISTRY: ghcr.io 9 | IMAGE_NAME: ${{ github.repository }} 10 | 11 | jobs: 12 | build-and-push-image: 13 | runs-on: ubuntu-latest 14 | permissions: 15 | contents: read 16 | packages: write 17 | 18 | steps: 19 | - name: Checkout repository 20 | uses: actions/checkout@v3 21 | 22 | - name: get-npm-version 23 | id: package-version 24 | uses: martinbeentjes/npm-get-version-action@v1.3.1 25 | 26 | - name: Log in to the Container registry 27 | uses: docker/login-action@v2 28 | with: 29 | registry: ${{ env.REGISTRY }} 30 | username: ${{ github.actor }} 31 | password: ${{ secrets.GITHUB_TOKEN }} 32 | 33 | - name: Extract metadata (tags, labels) for Docker 34 | id: meta 35 | uses: docker/metadata-action@v4 36 | with: 37 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} 38 | 39 | - name: Build and push Docker image 40 | uses: docker/build-push-action@v4 41 | with: 42 | context: . 43 | push: true 44 | tags: ghcr.io/pradumnasaraf/opensource-api:${{ steps.package-version.outputs.current-version}} 45 | labels: ${{ steps.meta.outputs.labels }} 46 | -------------------------------------------------------------------------------- /.github/workflows/releases.yml: -------------------------------------------------------------------------------- 1 | name: Releases 2 | on: 3 | push: 4 | branches: 5 | - main 6 | 7 | jobs: 8 | changelog: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - uses: actions/checkout@v3 13 | 14 | - name: conventional Changelog Action 15 | id: changelog 16 | uses: TriPSs/conventional-changelog-action@v3 17 | with: 18 | github-token: ${{ secrets.PA_TOKEN }} 19 | version-file: "./package.json,./package-lock.json" 20 | 21 | - name: create release 22 | uses: actions/create-release@v1 23 | if: ${{ steps.changelog.outputs.skipped == 'false' }} 24 | env: 25 | GITHUB_TOKEN: ${{ secrets.PA_TOKEN }} 26 | with: 27 | tag_name: ${{ steps.changelog.outputs.tag }} 28 | release_name: ${{ steps.changelog.outputs.tag }} 29 | body: ${{ steps.changelog.outputs.clean_changelog }} 30 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .env -------------------------------------------------------------------------------- /.gitpod.Dockerfile: -------------------------------------------------------------------------------- 1 | FROM gitpod/workspace-mongodb 2 | -------------------------------------------------------------------------------- /.gitpod.yml: -------------------------------------------------------------------------------- 1 | tasks: 2 | - name: Database 3 | command: | 4 | mkdir -p /workspace/data && mongod --dbpath /workspace/data 5 | 6 | - name: Server 7 | init: | 8 | npm ci 9 | npm run env 10 | command: npm run dev 11 | 12 | image: 13 | file: .gitpod.Dockerfile 14 | 15 | github: 16 | prebuilds: 17 | master: true 18 | branches: true 19 | pullRequests: true 20 | pullRequestsFromForks: true 21 | addCheck: true 22 | addComment: false 23 | addBadge: true 24 | -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | . "$(dirname -- "$0")/_/husky.sh" 3 | 4 | npx lint-staged 5 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | *.html 2 | CHANGELOG.md -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "semi": true, 3 | "tabWidth": 2, 4 | "bracketSpacing": true 5 | } 6 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # [1.12.0](https://github.com/Pradumnasaraf/OpenSource-API/compare/v1.11.2...v1.12.0) (2023-06-24) 2 | 3 | 4 | ### Features 5 | 6 | * change API to ES6 ([#55](https://github.com/Pradumnasaraf/OpenSource-API/issues/55)) ([3007755](https://github.com/Pradumnasaraf/OpenSource-API/commit/3007755593cc6fd862eda741b267cf81f1ed57af)) 7 | 8 | 9 | 10 | ## [1.11.2](https://github.com/Pradumnasaraf/OpenSource-API/compare/v1.11.1...v1.11.2) (2023-05-31) 11 | 12 | 13 | ### Bug Fixes 14 | 15 | * compose mongo version + change action secret ([3d1c291](https://github.com/Pradumnasaraf/OpenSource-API/commit/3d1c291b912ee4327e9fd9dfe57c60890e1a0ccf)) 16 | 17 | 18 | 19 | ## [1.11.1](https://github.com/Pradumnasaraf/OpenSource-API/compare/v1.11.0...v1.11.1) (2023-05-31) 20 | 21 | 22 | ### Bug Fixes 23 | 24 | * Add version to GHCR and DockerHub images ([83bf3aa](https://github.com/Pradumnasaraf/OpenSource-API/commit/83bf3aac35f45e8d13bff7010483bdef71e00b32)) 25 | 26 | 27 | 28 | # [1.11.0](https://github.com/Pradumnasaraf/OpenSource-API/compare/v1.10.0...v1.11.0) (2023-02-10) 29 | 30 | 31 | ### Features 32 | 33 | * add config file support ([f296b53](https://github.com/Pradumnasaraf/OpenSource-API/commit/f296b5358ff4302ee12e15f1fdbb96cdbd7286b7)) 34 | 35 | 36 | 37 | # [1.10.0](https://github.com/Pradumnasaraf/OpenSource-API/compare/v1.9.2...v1.10.0) (2023-02-02) 38 | 39 | 40 | ### Features 41 | 42 | * Added urlencoded bodyparser support ([2289156](https://github.com/Pradumnasaraf/OpenSource-API/commit/228915643d8e8b27c39c14da1e9f16fde3c87198)) 43 | 44 | 45 | 46 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | - Demonstrating empathy and kindness toward other people 21 | - Being respectful of differing opinions, viewpoints, and experiences 22 | - Giving and gracefully accepting constructive feedback 23 | - Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | - Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | - The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | - Trolling, insulting or derogatory comments, and personal or political attacks 33 | - Public or private harassment 34 | - Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | - Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | pradumnasaraf@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | > IMPORTANT **Note** 2 | > 3 | > **Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.** 4 | 5 | ## 👨‍💻 Prerequisite 6 | 7 | #### Documentation 8 | 9 | - [Git](https://git-scm.com/) 10 | - [Markdown](https://www.markdownguide.org/basic-syntax/) 11 | - [Git with Atlassian](https://www.atlassian.com/git/tutorials/learn-git-with-bitbucket-cloud) 12 | 13 | #### Code 14 | 15 | - [Node.js](https://nodejs.org/en/) 16 | - [NPM](https://www.npmjs.com/) 17 | 18 | ## 💥 How to Contribute 19 | 20 | - Look at the existing [**Issues**](https://github.com/Pradumnasaraf/OpenSource-API/issues) or [**create a new issue**](https://github.com/Pradumnasaraf/OpenSource-API/issues/new/choose)! 21 | - [**Fork the Repo**](https://github.com/Pradumnasaraf/OpenSource-API/fork). Then, create a branch for any issue that you are working on. Finally, commit your work. 22 | - Create a **[Pull Request](https://github.com/Pradumnasaraf/OpenSource-API/compare)** (_PR_), which will be promptly reviewed and given suggestions for improvements by the community. 23 | - Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR. 24 | 25 | Please note that the above instructions assume familiarity with Git, Markdown, Node.js, and NPM. If you need any assistance or have further questions, feel free to ask. Happy contributing! 26 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:16-alpine 2 | WORKDIR /app 3 | COPY package.json ./ 4 | ARG NODE_ENV 5 | RUN if [ "$NODE_ENV" = "development" ]; then npm install ; else npm install --omit=dev --ignore-scripts; fi 6 | COPY . ./ 7 | CMD ["node", "index.js"] -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![OpenSource API banner](https://user-images.githubusercontent.com/51878265/212617054-61bc38e5-ea65-4594-a23c-f46de14b7fec.png) 2 | 3 |
4 | 5 |

An Open Source, free, and public API.

6 | 7 | [![Publish Docker Image to DockerHub](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/publish-dockerhub.yml/badge.svg)](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/publish-dockerhub.yml) [![Publish Image to GitHub Container Registry](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/publish-ghcr.yml/badge.svg)](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/publish-ghcr.yml) [![Unit Tests + Lint](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/lint-testing.yml/badge.svg)](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/lint-testing.yml) [![Format](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/prettier.yml/badge.svg)](https://github.com/Pradumnasaraf/OpenSource-API/actions/workflows/prettier.yml) 8 | 9 |

10 | 11 |
12 | 13 | ## 🛠️ Technlogies used 14 | 15 | | Server | Database | Testing | Deployment | 16 | | :------------------------: | :------: | :---------: | :--------: | 17 | | Node.js, Express, Mongoose | MongoDB | Mocha, Chai | Vercel | 18 | 19 | ## 📌 Endpoints 20 | 21 | | Endpoints | Description | Method | 22 | | :---------------- | :-------------------------- | :----- | 23 | | `/` | Home page. | GET | 24 | | `/api/devtip` | Returns a list of dev tips. | GET | 25 | | `/api/devtip/:id` | Returns a single dev tip. | GET | 26 | | `/api/devtip` | Creates a new dev tip. | POST | 27 | | `/api/devtip/:id` | Updates a dev tip. | PATCH | 28 | | `/api/devtip/:id` | Deletes a dev tip. | DELETE | 29 | 30 | ## 👨‍💻 Developing the API 31 | 32 | This section includes how to test and develop API at your end. You can either run it in the cloud using **Gitpod** or run it inside a container using **docker** or choose to set up the complete environment locally. 33 | 34 | **GitPod** 35 | 36 | [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Pradumnasaraf/OpenSource-API) 37 | 38 | **Docker Compose** 39 | 40 | Prerequisites - Docker and Compose installed in your local system. 41 | 42 | You can run below command and you can access the API at `localhost:9009` 43 | 44 | ```bash 45 | docker compose up 46 | ``` 47 | 48 | **Local setup** 49 | 50 | Prerequisites- Node.js installed and a Mongo server on your localhost. 51 | 52 | Make sure you have installed all the dependencies and you have a MongoDB server running on your local machine. Also, make sure are in the root directory of the project. 53 | 54 | Step 1: Copy `.env.example` to `.env`. 55 | 56 | ```bash 57 | npm run env 58 | ``` 59 | 60 | Step 2: Run the app in development mode. 61 | 62 | ```bash 63 | npm run dev 64 | ``` 65 | 66 | ## 🛡️ License 67 | 68 | **OpenSource API** is licensed under the GPL-3.0 License - see the [LICENSE](/LICENSE) file for details. 69 | 70 | ## 🤝 Support 71 | 72 | Don't forget to leave a star ⭐️. 73 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | ## Reporting a Vulnerability 2 | 3 | Please don't raise an issue that can be more vulnerable to put out in public. Instead, report via http://pradumnasaraf.dev/contact. 4 | -------------------------------------------------------------------------------- /config/config.js: -------------------------------------------------------------------------------- 1 | import dotenv from "dotenv"; 2 | dotenv.config(); 3 | 4 | export const MONGODB_URL = process.env.MONGODB_URL; 5 | export const PORT = process.env.PORT || 9009; 6 | export const COLLECTION_NAME = process.env.COLLECTION_NAME; 7 | export const DB_NAME = process.env.DB_NAME; 8 | -------------------------------------------------------------------------------- /controller/devtip/deleteDevTip.js: -------------------------------------------------------------------------------- 1 | import DevTip from "../../models/devTipSchema.js"; 2 | const deleteDevTip = async (req, res) => { 3 | try { 4 | await DevTip.findByIdAndDelete(req.params.id); 5 | res.json({ summary: "data has been deleted" }); 6 | } catch (e) { 7 | res.status(400).json({ 8 | summary: 9 | "unable to delete the dev tip, either the id is invalid or the Dev Tip is not found", 10 | }); 11 | } 12 | }; 13 | export default deleteDevTip; 14 | -------------------------------------------------------------------------------- /controller/devtip/getDevTip.js: -------------------------------------------------------------------------------- 1 | import DevTip from "../../models/devTipSchema.js"; 2 | const getDevTip = async (req, res) => { 3 | try { 4 | const devTip = await DevTip.find(); 5 | res.status(200).json({ 6 | summary: "success", 7 | results: devTip.length, 8 | data: { 9 | devtip: devTip, 10 | }, 11 | }); 12 | } catch (e) { 13 | res.status(400).json({ 14 | summary: "dev tip not found", 15 | }); 16 | } 17 | }; 18 | export default getDevTip; 19 | -------------------------------------------------------------------------------- /controller/devtip/getDevTipById.js: -------------------------------------------------------------------------------- 1 | import DevTip from "../../models/devTipSchema.js"; 2 | const getDevTipByID = async (req, res) => { 3 | try { 4 | const devTip = await DevTip.findById(req.params.id); 5 | res.status(200).json({ 6 | summary: "success", 7 | data: { 8 | devtip: devTip, 9 | }, 10 | }); 11 | } catch (e) { 12 | res.status(400).json({ 13 | summary: "either the id is invalid or the dev tip is not found", 14 | }); 15 | } 16 | }; 17 | 18 | export default getDevTipByID; 19 | -------------------------------------------------------------------------------- /controller/devtip/postDevTip.js: -------------------------------------------------------------------------------- 1 | import DevTip from "../../models/devTipSchema.js"; 2 | const postDevTip = async (req, res) => { 3 | try { 4 | if (!req.body.message) { 5 | return res.status(400).json({ 6 | summary: "please provide a dev tip, message is empty.", 7 | }); 8 | } 9 | const devTip = await DevTip.create(req.body); 10 | res.status(201).json({ 11 | summary: "your dev tip has been saved", 12 | data: { 13 | devtip: devTip, 14 | }, 15 | }); 16 | } catch (e) { 17 | console.log(e); 18 | res.status(400).json({ 19 | summary: "unable to save the dev tip", 20 | }); 21 | } 22 | }; 23 | 24 | export default postDevTip; 25 | -------------------------------------------------------------------------------- /controller/devtip/updateDevTip.js: -------------------------------------------------------------------------------- 1 | import DevTip from "../../models/devTipSchema.js"; 2 | const updateDevTip = async (req, res) => { 3 | try { 4 | if (!req.body.message) { 5 | return res.status(400).json({ 6 | summary: "please provide a dev tip, message is empty.", 7 | }); 8 | } 9 | const devTip = await DevTip.findByIdAndUpdate(req.params.id, req.body, { 10 | new: true, 11 | runValidators: true, 12 | }); 13 | 14 | res.status(200).json({ 15 | summary: "your data has been updated!", 16 | data: { 17 | devtip: devTip, 18 | }, 19 | }); 20 | } catch (e) { 21 | res.status(400).json({ 22 | summary: 23 | "unable to update the dev tip, either the id is invalid or the dev tip is not found", 24 | }); 25 | } 26 | }; 27 | 28 | export default updateDevTip; 29 | -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | version: "3.9" 2 | 3 | services: 4 | node-app: 5 | container_name: node-app 6 | build: 7 | context: . 8 | dockerfile: Dockerfile 9 | args: 10 | NODE_ENV: development 11 | image: opensource-api 12 | command: npm run dev 13 | ports: 14 | - 9009:9009 15 | environment: 16 | - MONGODB_URL=mongodb://mongodb:27017/myapp 17 | - PORT=9009 18 | depends_on: 19 | - mongo 20 | networks: 21 | - os-api-network 22 | volumes: 23 | - .:/app 24 | - /app/node_modules 25 | 26 | mongo: 27 | container_name: mongodb 28 | image: mongo:6.0 29 | volumes: 30 | - mongo-db:/data/db 31 | networks: 32 | - os-api-network 33 | 34 | volumes: 35 | mongo-db: 36 | networks: 37 | os-api-network: 38 | name: os-api-network 39 | driver: bridge 40 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import express from "express"; 2 | import mongoose from "mongoose"; 3 | import logger from "./middleware/logger.js"; 4 | import path from "path"; 5 | import { fileURLToPath } from "url"; 6 | import ErrorHandle from "./middleware/404.js"; 7 | import devTipRouter from "./routes/devTipRouter.js"; 8 | import { MONGODB_URL, DB_NAME, PORT } from "./config/config.js"; 9 | const app = express(); 10 | const __filename = fileURLToPath(import.meta.url); 11 | const __dirname = path.dirname(__filename); 12 | 13 | // eslint-disable-next-line no-undef 14 | app.use("/", express.static(path.join(__dirname, "./public"))); 15 | app.use(express.json()); 16 | app.use(express.urlencoded({ extended: true })); 17 | app.use(logger); 18 | app.use("/api/devtip", devTipRouter); 19 | app.use(ErrorHandle); 20 | 21 | mongoose.set("strictQuery", false); 22 | mongoose 23 | // eslint-disable-next-line no-undef 24 | .connect(MONGODB_URL, { 25 | useNewUrlParser: true, 26 | useUnifiedTopology: true, 27 | dbName: DB_NAME, 28 | }) 29 | .then(() => { 30 | console.log("Successfully connected to MongoDB."); 31 | }) 32 | .catch((err) => { 33 | console.log(err); 34 | }); 35 | 36 | // eslint-disable-next-line no-undef 37 | app.listen(PORT, () => 38 | console.log(`Server is LIVE at -> http://localhost:${PORT}`) 39 | ); 40 | 41 | export default app; 42 | -------------------------------------------------------------------------------- /middleware/404.js: -------------------------------------------------------------------------------- 1 | const pageNotFound = async function (req, res) { 2 | res.status(404).send("404 - Page not found"); 3 | }; 4 | 5 | export default pageNotFound; 6 | -------------------------------------------------------------------------------- /middleware/logger.js: -------------------------------------------------------------------------------- 1 | const logger = async (req, res, next) => { 2 | console.log(`Endpoint: ${req.url}, Method: ${req.method}`); 3 | next(); 4 | }; 5 | 6 | export default logger; 7 | -------------------------------------------------------------------------------- /models/devTipSchema.js: -------------------------------------------------------------------------------- 1 | import mongoose from "mongoose"; 2 | import { COLLECTION_NAME } from "../config/config.js"; 3 | 4 | const devtip = new mongoose.Schema( 5 | { 6 | message: { 7 | type: String, 8 | required: true, 9 | }, 10 | }, 11 | { 12 | versionKey: false, // Set versionKey option to false (__v) 13 | collection: COLLECTION_NAME, // Set collection name from .env file 14 | } 15 | ); 16 | 17 | export default mongoose.model("devtipss", devtip); 18 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "opensource-api", 3 | "version": "1.12.0", 4 | "description": "A free and public Open Source API", 5 | "main": "index.js", 6 | "scripts": { 7 | "start": "node index.js", 8 | "dev": "nodemon index.js", 9 | "format": "prettier --write .", 10 | "lint": "eslint .", 11 | "lint:fix": "eslint --fix .", 12 | "prepare": "husky install", 13 | "test": "mocha test/**/*.test.js --exit", 14 | "env": "cp .env.example .env" 15 | }, 16 | "author": "Pradumna Saraf", 17 | "license": "MIT", 18 | "dependencies": { 19 | "dotenv": "^16.3.1", 20 | "express": "^4.18.2", 21 | "mongoose": "^7.3.1" 22 | }, 23 | "devDependencies": { 24 | "chai": "^4.3.7", 25 | "chai-http": "^4.4.0", 26 | "eslint": "^8.43.0", 27 | "husky": "^8.0.3", 28 | "lint-staged": "^13.2.2", 29 | "mocha": "^10.2.0", 30 | "nodemon": "^2.0.22", 31 | "prettier": "^2.8.8" 32 | }, 33 | "lint-staged": { 34 | "*.{js,md}": "prettier --write", 35 | "*.js": "eslint --fix" 36 | }, 37 | "type": "module", 38 | "engines": { 39 | "node": ">=18.0.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | OpenSource API 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 52 | 53 |
54 |

OpenSource API

55 |

An Open Source, free, and public API 🚀.

56 |
Developed by - @Pradumnasaraf :-)
57 |
58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /public/style.css: -------------------------------------------------------------------------------- 1 | body { 2 | height: 100vh; 3 | width: 100wh; 4 | font-family: "Open Sans", sans-serif; 5 | display: flex; 6 | align-items: center; 7 | justify-content: center; 8 | background-color: antiquewhite; 9 | color: rgb(255, 160, 43); 10 | } 11 | 12 | #main { 13 | text-align: center; 14 | font-size: 2em; 15 | } 16 | 17 | #developer { 18 | color: rgb(43, 43, 43); 19 | font-size: 0.6em; 20 | text-align: right; 21 | } 22 | 23 | #developer a { 24 | text-decoration: none; 25 | color: rgb(250, 82, 82); 26 | } 27 | 28 | #developer a:hover { 29 | color: rgb(255, 160, 43); 30 | } 31 | -------------------------------------------------------------------------------- /routes/devTipRouter.js: -------------------------------------------------------------------------------- 1 | import express from "express"; 2 | const router = express.Router(); 3 | 4 | import getDevTip from "../controller/devtip/getDevTip.js"; 5 | import postDevTip from "../controller/devtip/postDevTip.js"; 6 | import updateDevTip from "../controller/devtip/updateDevTip.js"; 7 | import deleteDevTip from "../controller/devtip/deleteDevTip.js"; 8 | import getDevTipById from "../controller/devtip/getDevTipById.js"; 9 | 10 | router.get("/", getDevTip); 11 | router.post("/", postDevTip); 12 | router.delete("/", deleteDevTip); 13 | router.patch("/:id", updateDevTip); 14 | router.get("/:id", getDevTipById); 15 | router.delete("/:id", deleteDevTip); 16 | 17 | export default router; 18 | -------------------------------------------------------------------------------- /test/devtips/deleteDevTip.test.js: -------------------------------------------------------------------------------- 1 | import chai from "chai"; 2 | import chaiHttp from "chai-http"; 3 | import server from "../../index.js"; 4 | import dotenv from "dotenv"; 5 | dotenv.config(); 6 | const testId = process.env.TEST_DEV_TIP_ID; 7 | 8 | // Assertion Style 9 | chai.should(); 10 | chai.use(chaiHttp); 11 | /** Test the GET /api/devtip:ID route */ 12 | 13 | /* eslint-disable-next-line */ 14 | describe("----- DELETE /api/devtip/:id -----", () => { 15 | it("It should DELETE a devtip by ID", (done) => { 16 | chai 17 | .request(server) 18 | .delete("/api/devtip/" + testId) 19 | .end((err, response) => { 20 | response.should.have.status(200); 21 | response.body.should.be.a("object"); 22 | response.body.should.have 23 | .property("summary") 24 | .eq("data has been deleted"); 25 | }); 26 | done(); 27 | }); 28 | 29 | it("It should NOT DELETE a devtip by ID", (done) => { 30 | const randomID = "1010"; 31 | chai 32 | .request(server) 33 | .delete("/api/devtip/" + randomID) 34 | .end((err, response) => { 35 | response.should.have.status(400); 36 | response.body.should.have 37 | .property("summary") 38 | .eq( 39 | "unable to delete the dev tip, either the id is invalid or the Dev Tip is not found" 40 | ); 41 | }); 42 | done(); 43 | }); 44 | }); 45 | -------------------------------------------------------------------------------- /test/devtips/getDevTip.test.js: -------------------------------------------------------------------------------- 1 | import chai from "chai"; 2 | import chaiHttp from "chai-http"; 3 | import server from "../../index.js"; 4 | 5 | // Assertion Style 6 | chai.should(); 7 | chai.use(chaiHttp); 8 | 9 | /** Test the GET /api/devtip route */ 10 | 11 | describe("----- GET /api/devtip -----", () => { 12 | it("It should GET all the devtips", (done) => { 13 | chai 14 | .request(server) 15 | .get("/api/devtip") 16 | .end((err, response) => { 17 | response.should.have.status(200); 18 | response.body.should.be.a("object"); 19 | response.body.should.have.property("data"); 20 | response.body.should.have.property("results"); 21 | response.body.data.should.have.property("devtip"); 22 | }); 23 | done(); 24 | }); 25 | it("It should NOT GET all the devtips", (done) => { 26 | chai 27 | .request(server) 28 | .get("/api/devtips") 29 | .end((err, response) => { 30 | response.should.have.status(404); 31 | }); 32 | done(); 33 | }); 34 | }); 35 | -------------------------------------------------------------------------------- /test/devtips/getDevTipByID.test.js: -------------------------------------------------------------------------------- 1 | import chai from "chai"; 2 | import chaiHttp from "chai-http"; 3 | import server from "../../index.js"; 4 | import dotenv from "dotenv"; 5 | dotenv.config(); 6 | const testId = process.env.TEST_DEV_TIP_ID; 7 | 8 | // Assertion Style 9 | chai.should(); 10 | chai.use(chaiHttp); 11 | 12 | /** Test the GET /api/devtip:ID route */ 13 | 14 | describe("----- GET /api/devtip/:id -------", () => { 15 | it("It should GET a devtip by ID", (done) => { 16 | chai 17 | .request(server) 18 | .get("/api/devtip/" + testId) 19 | .end((err, response) => { 20 | response.should.have.status(200); 21 | response.body.should.be.a("object"); 22 | response.body.should.have.property("summary"); 23 | response.body.data.should.have.property("devtip"); 24 | }); 25 | done(); 26 | }); 27 | it("It should NOT GET a devtip by ID", (done) => { 28 | const randomID = "5656"; 29 | chai 30 | .request(server) 31 | .get("/api/devtip/" + randomID) 32 | .end((err, response) => { 33 | response.should.have.status(400); 34 | response.body.should.have 35 | .property("summary") 36 | .eq("either the id is invalid or the dev tip is not found"); 37 | }); 38 | done(); 39 | }); 40 | }); 41 | -------------------------------------------------------------------------------- /test/devtips/hopepage.test.js: -------------------------------------------------------------------------------- 1 | import chai from "chai"; 2 | import chaiHttp from "chai-http"; 3 | import server from "../../index.js"; 4 | 5 | // Assertion Style 6 | chai.should(); 7 | chai.use(chaiHttp); 8 | 9 | describe("----- GET / HOMEPAGE -----", () => { 10 | it("It should GET the HTML home page", (done) => { 11 | chai 12 | .request(server) 13 | .get("/") 14 | .end((err, response) => { 15 | response.should.have.status(200); 16 | response.should.be.html; 17 | }); 18 | done(); 19 | }); 20 | }); 21 | -------------------------------------------------------------------------------- /test/devtips/postDevTip.test.js: -------------------------------------------------------------------------------- 1 | import chai from "chai"; 2 | import chaiHttp from "chai-http"; 3 | import server from "../../index.js"; 4 | 5 | // Assertion Style 6 | chai.should(); 7 | chai.use(chaiHttp); 8 | 9 | describe("----- POST /api/devtip -----", () => { 10 | it("It should POST a new dev tip", (done) => { 11 | const devtip = { 12 | message: "Test Dev Tip Message", 13 | }; 14 | chai 15 | .request(server) 16 | .post("/api/devtip") 17 | .send(devtip) 18 | .end((err, response) => { 19 | response.should.have.status(201); 20 | response.body.should.be.a("object"); 21 | response.body.should.have 22 | .property("summary") 23 | .eq("your dev tip has been saved"); 24 | response.body.data.should.have.property("devtip"); 25 | }); 26 | done(); 27 | }); 28 | it("It should NOT POST a new dev tip without the message property", (done) => { 29 | const devtip = { 30 | message: "", 31 | }; 32 | chai 33 | .request(server) 34 | .post("/api/devtip") 35 | .send(devtip) 36 | .end((err, response) => { 37 | response.should.have.status(400); 38 | response.body.should.be.a("object"); 39 | response.body.should.have 40 | .property("summary") 41 | .eq("please provide a dev tip, message is empty."); 42 | }); 43 | done(); 44 | }); 45 | }); 46 | -------------------------------------------------------------------------------- /test/devtips/updateDevTip.test.js: -------------------------------------------------------------------------------- 1 | import chai from "chai"; 2 | import chaiHttp from "chai-http"; 3 | import server from "../../index.js"; 4 | import dotenv from "dotenv"; 5 | dotenv.config(); 6 | const testId = process.env.TEST_DEV_TIP_ID; 7 | 8 | // Assertion Style 9 | chai.should(); 10 | chai.use(chaiHttp); 11 | 12 | describe("----- UPDATE /api/devtip/:id -----", () => { 13 | it("It should UPDATE a devtip by ID", (done) => { 14 | const devtip = { 15 | message: "Test Dev Tip Message", 16 | }; 17 | chai 18 | .request(server) 19 | .patch("/api/devtip/" + testId) 20 | .send(devtip) 21 | .end((err, response) => { 22 | response.should.have.status(200); 23 | response.body.should.be.a("object"); 24 | response.body.should.have 25 | .property("summary") 26 | .eq("your data has been updated!"); 27 | }); 28 | done(); 29 | }); 30 | 31 | it("It should NOT UPDATE a devtip if ID is wrong", (done) => { 32 | const testID = "1010"; 33 | const devtip = { 34 | message: "Test Dev Tip Message", 35 | }; 36 | chai 37 | .request(server) 38 | .patch("/api/devtip/" + testID) 39 | .send(devtip) 40 | .end((err, response) => { 41 | response.should.have.status(400); 42 | response.body.should.be.a("object"); 43 | response.body.should.have 44 | .property("summary") 45 | .eq( 46 | "unable to update the dev tip, either the id is invalid or the dev tip is not found" 47 | ); 48 | }); 49 | done(); 50 | }); 51 | 52 | it("It should NOT UPDATE a devtip if message is empty", (done) => { 53 | const testID = "63c13c24be5bda6b556d9a54"; 54 | const devtip = { 55 | message: "", 56 | }; 57 | chai 58 | .request(server) 59 | .patch("/api/devtip/" + testID) 60 | .send(devtip) 61 | .end((err, response) => { 62 | response.should.have.status(400); 63 | response.body.should.be.a("object"); 64 | response.body.should.have 65 | .property("summary") 66 | .eq("please provide a dev tip, message is empty."); 67 | }); 68 | done(); 69 | }); 70 | }); 71 | -------------------------------------------------------------------------------- /vercel.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Open-API", 3 | "version": 2, 4 | "builds": [ 5 | { 6 | "src": "./index.js", 7 | "use": "@vercel/node" 8 | } 9 | ], 10 | "rewrites": [ 11 | { 12 | "source": "/(.*)", 13 | "destination": "/" 14 | } 15 | ] 16 | } 17 | --------------------------------------------------------------------------------