Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: flesh in api router #806

Merged
merged 3 commits into from
Feb 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 44 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,6 @@ Github Codespaces.
Alternatively, git clone the repo and build, test, and deploy apps locally using
the [devcontainer](.devcontainer/README.md).

## Architecture

This repository houses a collection of event-driven microservices, built on a
powerful Platform as a Service (PaaS) foundation. The integration of
Infrastructure as Code (IaC) ensures a streamlined DevOps pipeline for
continuous integration and continuous deployment (CI/CD) leveraging the power of
AWS.

![Flow Chart](docs/flow-chart.drawio.svg)

### Pull Request Lifecycle (~5 mins)

1. Checkout a new branch from main using git.
Expand Down Expand Up @@ -102,12 +92,56 @@ AWS.
git push
```

## Infrastructure

### Architecture

This repository houses a collection of event-driven microservices, built on a
powerful Platform as a Service (PaaS) foundation. The integration of
Infrastructure as Code (IaC) ensures a streamlined DevOps pipeline for
continuous integration and continuous deployment (CI/CD) leveraging the power of
AWS.

![Flow Chart](docs/flow-chart.drawio.svg)

## Provisioning

1. Setup [AWS Org Formation](/platform/aws-org-formation/README.md).

2. Login via SSO, bootstrap deployments, deploy platform, deploy services, and
then deploy clients.

```bash
rush sso
rush cdk:bootstrap
rush cdk:deploy --to tag:deploy-platform
rush cdk:deploy --to tag:services
rush cdk:deploy --to tag:clients
```

3. Login via SSO to tools account and then deploy tools.

```bash
rush sso -p tools
rush cdk:bootstrap
rush cdk:deploy --to tag:deploy-tools
```

## Documentation

See [Documentation](docs/index.md).

> **Note** Use `rush help` for information on builtin commands.

### Third Party Documentation

- [AWS CLI](https://docs.aws.amazon.com/cdk/v2/guide/cli.html)
- [Typescript](https://www.typescriptlang.org/docs/)
- [Jest](https://jestjs.io/)
- [RushJS](https://rushjs.io)
- [Selecting Subsets](https://rushjs.io/pages/developer/selecting_subsets/)
- [Rushstack](https://github.com/microsoft/rushstack)

## Contributing

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
Expand Down
1 change: 1 addition & 0 deletions clients/admin-client/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ function App() {
{url: `https://jukebox.${parentDomainName}`, label: 'Jukebox'},
{url: `https://design.${parentDomainName}`, label: 'Design System'},
{url: `https://api.${parentDomainName}`, label: 'Developer API'},
{url: 'https://nekosgate.awsapps.com/mail', 'label': 'WorkMail'}
]}/>
</>
);
Expand Down
2 changes: 0 additions & 2 deletions clients/design-system/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@main/badge/badge-storybook.svg)](link
to site)

![CloudFormation Diagram](tree-designer.png)

This
[design system](https://storybook.js.org/tutorials/design-systems-for-developers/)
contains common components for use in other front end applications. It contains
Expand Down
1 change: 1 addition & 0 deletions clients/design-system/stacks/design-system.stack.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ export class DesignSystemStack extends cdk.Stack {
bucketName: `${awsAccountId}-${stageName}-design-system-bucket`,
accessControl: BucketAccessControl.PRIVATE,
removalPolicy: RemovalPolicy.DESTROY,
autoDeleteObjects: true,
});

const originAccessIdentity = new OriginAccessIdentity(
Expand Down
Binary file removed clients/design-system/tree-designer.png
Binary file not shown.
File renamed without changes.
File renamed without changes.
2 changes: 0 additions & 2 deletions services/jukebox/README.md → clients/jukebox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
![TypeScript](https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=FFF&style=flat-square)
[![GitHub Stars](https://img.shields.io/github/stars/hxtree/cats-cradle?style=social)](https://github.com/hxtree/cats-cradle/stargazers)

![CloudFormation Diagram](tree-designer.png)

This services plays only retro music -- so turn up the volume to 11. We're
talking Impulse Tracker (\*.it) files.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/**
* Commits to source control MUST adhere to the Conventional Commits standard.
* {@link https://www.conventionalcommits.org/en/v1.0.0/}
*/
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
Expand Down
Loading
Loading