Skip to content

README-Template.md

Latest commit

 

History

History
115 lines (83 loc) · 2.63 KB

README-Template.md

File metadata and controls

115 lines (83 loc) · 2.63 KB

Project Name

Brief description of what this project does.

Table of Contents

##What this project does -Explain: what this project does

##Why is this project useful -Explain: why it is useful

Setup

  1. Install Dependencies
npm install
  1. Environment Setup Create a .env file with the following variables:
KEY_ONE=value
KEY_TWO=value
  1. Additional Setup Steps Any other necessary setup instructions.

Docker Setup

To run this project using Docker, follow these steps:

  1. Run Docker Compose
    docker-compose up -d
  2. Other Docker Commands/Steps

Scopes

The following OAuth scopes are required:

const SCOPES = [
  'scope.one',
  'scope.two',
  'scope.three'
];

Each scope enables specific functionality:

  • scope.one - Description of functionality
  • scope.two - Description of functionality
  • scope.three - Description of functionality

These scopes must be configured in your OAuth settings.

Endpoints

Group One

  • GET /api/endpoint - Description
    • Query params: param1, param2
    • Response: { data: value }

Group Two

  • POST /api/endpoint - Description
    • Body: { key: value }
    • Response: { success: true }

Required Scopes

  • scope:one - Description of what this scope enables
  • scope:two - Description of what this scope enables

Available Scripts

  • npm start - Description
  • npm test - Description
  • npm run custom - Description

Dependencies

Core

  • dependency-one
  • dependency-two

Development

  • dev-dependency-one
  • dev-dependency-two

Where to get help?

If you encounter any bugs or issues, please report them by opening a GitHub issue. For feedback or suggestions for new code examples, we encourage you to use this form.

Who maintains and contributes to this project

Various teams at HubSpot that focus on developer experience and app marketplace quality maintain and contribute to this project. In particular, this project was made possible by @therealdadams, @rahmona-henry, @zman81988, @natalijabujevic0708, and @zradford

License

License Name