https://github.com/teammates/teammates-ops

Maintenance and operations-related stuffs for TEAMMATES product
https://github.com/teammates/teammates-ops

Last synced: about 1 year ago
JSON representation

Maintenance and operations-related stuffs for TEAMMATES product

• Host: GitHub
• URL: https://github.com/teammates/teammates-ops
• Owner: TEAMMATES
• License: mit
• Created: 2018-09-29T13:17:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-20T02:16:37.000Z (about 2 years ago)
• Last Synced: 2024-04-20T03:27:22.069Z (about 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 155 KB
• Stars: 7
• Watchers: 11
• Forks: 14
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# TEAMMATES Maintenance and Operations Guide

[![GitHub Actions Build Status Tests](https://github.com/TEAMMATES/teammates-ops/workflows/Tests/badge.svg)](https://github.com/TEAMMATES/teammates-ops/actions)

This is the maintenance web site for TEAMMATES. It consists of documentations and several sub-projects necessary for keeping TEAMMATES running.

## Documentations

* The [**developer community structure**](community.md).

* [**Maintainer Guide**](maintainer-guide.md): regular tasks for core team members to keep the project moving.

* [**Platform Guide**](platform-guide.md): Google Cloud Platform-specific instructions, e.g. deployment.

## Tool Stack

Here are the tools used for TEAMMATES development/operations:

* [Google App Engine Java, Standard Environment](https://cloud.google.com/appengine/docs/standard/java/) or [Google App Engine, Flexible Environment](https://cloud.google.com/appengine/docs/flexible/custom-runtimes/) as the underlying platform. Additionally, we use the following GCP services:

  * [Google Cloud Datastore](https://cloud.google.com/datastore/) as the database

  * [Google Cloud Storage](https://cloud.google.com/storage) as the binary file storage

  * [Google Cloud Tasks](https://cloud.google.com/tasks/) as the background task scheduler

  * [Google Cloud Scheduler](https://cloud.google.com/scheduler/) as the cron job scheduler

  * [Google Cloud Logging](https://cloud.google.com/logging/) for application logs

  * [Google Cloud Trace](https://cloud.google.com/trace/) for performance and latency monitoring

* [Google OAuth 2.0](https://developers.google.com/identity/protocols/oauth2) for user authentication

* [SendGrid](https://sendgrid.com/) as the primary email sending service.

* [Apache Solr](https://solr.apache.org/) running in [Google Compute Engine](https://cloud.google.com/compute) as the full-text search service

* GitHub for hosting [code](https://github.com/TEAMMATES/teammates), [issue tracker](https://github.com/TEAMMATES/teammates/issues), [code patches](https://github.com/TEAMMATES/teammates/pulls), as well as [project management](https://github.com/TEAMMATES/teammates/projects)

* [![GitHub Actions Build Status Component Tests](https://github.com/TEAMMATES/teammates/workflows/Component%20Tests/badge.svg)](https://github.com/TEAMMATES/teammates/actions) [![GitHub Actions Build Status E2E Tests](https://github.com/TEAMMATES/teammates/workflows/E2E%20Tests/badge.svg)](https://github.com/TEAMMATES/teammates/actions) GitHub Actions for building/testing

* [![Codecov Coverage Status](https://codecov.io/gh/TEAMMATES/teammates/branch/master/graph/badge.svg)](https://codecov.io/gh/TEAMMATES/teammates) Codecov for hosting code coverage reports

## Sub-projects

- [Release script](release-script): automates many tasks related to releasing a new version