Skip to content

Commit 314e37b

Browse files
committed
docs: adds various links and index
1 parent f647d79 commit 314e37b

File tree

7 files changed

+82
-3
lines changed

7 files changed

+82
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Anomaly Labs
22
Working designs, documentation and references for all ideas at Anomaly labs.
33

4-
Current projects:
4+
## Infrastructure
55

66
<details>
7-
<summary>Terraform reference implementation for Linode</summary>
7+
<summary>[projects/terraform-linode](Terraform reference implementation for Linode)</summary>
88

99
The project aims to establish a standardised reference for using Terraform to provision and tear down infrastructure.
1010

@@ -14,16 +14,43 @@ Our key outcomes for this project are:
1414
- Document our understanding of Terraform with key steps to bootstrap a project
1515
- Document Linode related specifics around Terraform
1616
- Create a Template project that developers can use to speed up their setup
17+
18+
1719
</details>
1820

1921
<details>
2022
<summary>Containerised application deployment</summary>
23+
24+
Anomaly uses [Docker](https://docker.com) to develop and deploy all it's web applications. Deployment of the these applications has varied between client projects. This lab exercise aims to strongly define and provide a reference implementation that:
25+
26+
- Outlines a git based lifecycle of a deployment i.e test, quality assurance, and production
27+
- Clearly define the architecture while being cost effective
28+
- How envrionment variables are made available to various parts of the application
29+
- Role of Github or a deployment facility
30+
- Mechanism of storing and reteriving infrastructure level secrets
2131
</details>
2232

33+
## Workflow
34+
35+
<details>
36+
<summary>CI/CD pipeline</summary>
37+
</details>
38+
39+
# Web development
40+
2341
<details>
2442
<summary>Server side architecture</summary>
2543
</details>
2644

2745
<details>
2846
<summary>Web client side architecture</summary>
29-
</details>
47+
</details>
48+
49+
## Mobile
50+
51+
<details>
52+
<summary>iOS project layout</summary>
53+
</details>
54+
55+
# License
56+
Content of this repository are licensed under the Apache 2.0 license.

projects/arch-client/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Web client side architecture
2+
3+
4+
API:
5+
- https://github.com/Azure/autorest
6+
- https://github.com/ferdikoomen/openapi-typescript-codegen
7+
8+
9+
Articles:
10+
- https://fastapi.tiangolo.com/advanced/generate-clients/
11+
12+
13+
Project structure:
14+
- https://www.taniarascia.com/react-architecture-directory-structure/
15+
- https://www.robinwieruch.de/react-folder-structure/
16+
- https://www.xenonstack.com/insights/reactjs-project-structure

projects/arch-ios/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# iOS
2+
3+
4+
Projects:
5+
6+
API and Authentication:
7+
- https://github.com/apollographql/apollo-ios
8+
9+
10+
UI helpers:
11+
- https://github.com/danielsaidi/SystemNotification
12+
- https://github.com/danielsaidi/SwiftUIKit
13+
14+
15+
Extensions:
16+
- https://github.com/KeyboardKit/KeyboardKit

projects/arch-server/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Server side architecture
2+
3+
4+
5+
- FastAPI, https://fastapi.tiangolo.com
6+
- Configuration management, https://github.com/rochacbruno/dynaconf/

projects/ci-cd/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Continious integration and deployment
2+
3+
4+
Tools to be explored
5+
- [Helm](https://helm.sh), to manage Kubernetes applications
6+
- [Docker Hub](https://hub.docker.com), to manage and build images (follow the guide from Fairwinds)
7+
8+
Resources:
9+
- [Gitlab CI/CD guide](https://docs.gitlab.com/ee/ci/introduction/)
10+
- [Continuous Integration](https://martinfowler.com/articles/continuousIntegration.html), by Martin Fowler
11+
- [CI/CD Pipelines in Kubernetes](https://www.fairwinds.com/blog/best-practices-for-implementing-ci-cd-pipelines-in-kubernetes), by Fairwinds
12+
- [CI/CD best practices](https://www.digitalocean.com/community/tutorials/an-introduction-to-ci-cd-best-practices), by DigitalOcean

projects/docker-k8s/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Docker and Kubernetes application deployment
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Terraform reference implementation for Linode

0 commit comments

Comments
 (0)