Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 3.79 KB

README.md

File metadata and controls

74 lines (47 loc) · 3.79 KB
Raw

Ably Labs Template Repo

// This is a template repository to be used for all Ably Labs demos, tools & proof of concepts. Follow these steps to so this repo is easy to use for visitors & maintainers.

  1. Update the description of this repo.
  2. Add topics to this repo to clarify the language, tech stack and use case.
  3. Update the .gitignore file with one of the standard templates from GitHub.
  4. Update dependabot.yml with the configuration for your project.
  5. Replace https://github.com/ably-labs/ably-labs-template-repo/issues with the actual link of the repo in the CONTRIBUTING.md file.
  6. Update this README so it provides enough information for people to understand how it works, how to run it locally and how it can be deployed to the cloud (see GitHub).
  7. Update the query string in the static asset link:
  • For the logo at the bottom of this README and
  • Please use a custom favicon if you're creating a web app. The favicon should use the ably static asset endpoint <link rel="icon" type="image/svg+xml" href="https://static.ably.dev/motif-red.svg?lorem-ipsum" /> and ensure this uses the same unique identifier as the Ably logo on the README.
  • More info in this repo.
  1. Add a GitHub workflow to build/test/deploy your application. Use the Ably Control API GitHub action to avoid creating Ably apps/API keys manually (see the create-infra.yml workflow in this repo).
  2. Add this repository to the selected repositories in the Ably Labs org that are allowed to run GitHub Actions.

Once you're done, remove this section from the README. Good luck! 💪

Place eye candy header image here

// Place eye candy header image here ⬆️

Description

// Explanation of the contents of the repository. Describe the use case.

Tech stack

A high level architecture diagram tells more than a 1000 words

// A high level architecture diagram tells more than a 1000 words ⬆️

The project uses the following components:

  • X, brief explanation of the component
  • Y, brief explanation of the component
  • Ably, for realtime messaging at scale.

Building & running locally

Prerequisites

  1. Sign up or log in to ably.com, and create a new app and copy the API key.
  2. Install X
  3. Install Y

Building the project

// Add step by step instructions for building & running locally.

Deploying to the cloud

// Add step by step instructions for deployment. Refer to the GitHub workflow where possible.

Contributing

Want to help contributing to this project? Have a look at our contributing guide!

More info

// Add links to related blog, video, personal twitter handle.

Ably logo