diff --git a/README.md b/README.md index 5a86cfe..85a4a51 100644 --- a/README.md +++ b/README.md @@ -1 +1,12 @@ -# .github +# NaNLABS + +This repository contains the organization-level configuration for [NaNLABS](https://nanlabs.com) on GitHub: + +- **Profile README** (`profile/README.md`) — shown on our [organization page](https://github.com/nanlabs) +- **Pull Request template** (`.github/PULL_REQUEST_TEMPLATE.md`) — applied to all PRs across organization +- **Issue templates** (`.github/ISSUE_TEMPLATE/`) — bug reports, feature requests, documentation +- **Code owners** (`.github/CODEOWNERS`) — global ownership rules +- **Workflows** (`.github/workflows/`) — CI/CD for org-wide tooling (Danger, etc.) +- **Contributing guide** (`CONTRIBUTING.md`) — contribution guidelines for open-source projects + +For the public organization profile with all open-source projects, see [`profile/README.md`](profile/README.md). \ No newline at end of file diff --git a/profile/README.md b/profile/README.md index 1416001..be1a860 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,40 +1,166 @@ -# Welcome to NaNLABS Open Source +# Welcome to NaNLABS - - + + NaNLABS mascot -🚀 Welcome to NaNLABS' Open Source projects! We're thrilled to have you here as part of our vibrant open-source community. Explore our awesome list and highlighted repositories to find exciting projects to contribute to during Hacktoberfest! 🎉 - -Join us in celebrating the spirit of Hacktoberfest by contributing to our open-source projects. Your contributions make a difference! 🙌 - -Happy Hacking! 🌟 - -## Our Awesome List - -- **[awesome-nan](https://github.com/nanlabs/awesome-nan):** Dive into our curated list of Open Source examples and projects at NaNLABS. Discover awesome tools, libraries, and more. 🌟 - -## Our Featured Repositories - -- **[devops-reference](https://github.com/nanlabs/devops-reference):** This repository is a treasure trove of infrastructure components, CI/CD pipelines, and automation tools used across our projects. Get hands-on with technologies like Docker, Kubernetes, AWS, Terraform, Serverless Framework, and more. 💻 - -- **[frontend-reference](https://github.com/nanlabs/frontend-reference):** Explore the world of Frontend development with this repository. Find applications, examples, libraries, and tools related to React.js, TypeScript, JavaScript, CSS, and more. 🌐 - -- **[backend-reference](https://github.com/nanlabs/backend-reference):** Delve into Backend development with our collection of resources. Discover applications, examples, libraries, and tools related to Python, Golang, TypeScript, and more. 🧑‍💻 - -- **[nancy.js](https://github.com/nanlabs/nancy.js):** Nancy.js is home to various React components, hooks, apps, and libraries used in our projects. Explore React, TypeScript, state management, and more. 📦 - -- **[terraform-aws-starter](https://github.com/nanlabs/terraform-aws-starter):** Start your AWS infrastructure journey quickly with this Terraform starter kit. It covers secure state management, VPC configuration, security groups, RDS provisioning, secrets management, and GitHub Actions integration! ☁️ - -- **[aws-glue-etl-boilerplate](https://github.com/nanlabs/aws-glue-etl-boilerplate):** Check out this complete example of an AWS Glue application. It uses the Serverless Framework for infrastructure deployment and DevContainers/Docker Compose for local development with AWS Glue Libs, Spark, Jupyter Notebook, and more. 🧪 - -- **[automation-seed](https://github.com/nanlabs/automation-seed):** Automation Seed is an end-to-end automation framework built on WebdriverIO v7 and Selenium. It uses Selenoid for execution. Dive into automation, TypeScript, Selenium, and more. 🤖 - -## Sponsored External Projects - -We proudly sponsor the following projects: - -- **[create-awesome-node-app](https://github.com/Create-Node-App/create-node-app):** A powerful tool to scaffold your application. Choose from different templates and extensions for web apps, web extensions, monorepos, and more! 🌐 - -- **[recoil-devtools](https://github.com/ulises-jeremias/recoil-devtools):** Supercharge your Recoil development workflow (or any other state management architecture) with these developer tools. Simplify state change management like never before! 🔍 +**NaNLABS** is a software development company that builds reliable, scalable, and maintainable systems — from cloud infrastructure to end-to-end web applications. + +We also maintain a growing portfolio of open-source projects used internally and by the broader developer community. + +--- + +## 🌟 For Employees — Internal Resources + +> **Start here.** If you are a NaNLABS employee, the following internal tools and resources will help you get up to speed quickly. + +### 🖥️ Workstation Setup +- **[internal-workstation](https://github.com/nanlabs/internal-workstation)** — Host machine setup: chezmoi dotfiles, CLI helpers (`nan-*`), skills/agents for AI coding tools, and MCP templates. Based on the public [dots-ai](https://github.com/ulises-jeremias/dots-ai) project. + +### 🤖 AI Workspace +- **[internal-ai-workspace](https://github.com/nanlabs/internal-ai-workspace)** — Persistent memory, project context, personas, packs, and background job orchestration for AI-assisted development. Based on the public [ai-workspace](https://github.com/ulises-jeremias/ai-workspace) project. + +### 📋 Task Management +- **ClickUp** — Primary task tracker: [app.clickup.com](https://app.clickup.com) +- **Confluence** — Documentation wiki: [nanlabs.atlassian.net](https://nanlabs.atlassian.net) + +### 🧑‍💻 Development References +| Repository | Purpose | +|---|---| +| [frontend-reference](https://github.com/nanlabs/frontend-reference) | React, TypeScript, Next.js patterns | +| [backend-reference](https://github.com/nanlabs/backend-reference) | Python, Go, Node.js patterns | +| [devops-reference](https://github.com/nanlabs/devops-reference) | Docker, Kubernetes, AWS, Terraform | +| [terraform-aws-modules](https://github.com/nanlabs/terraform-aws-modules) | Reusable Terraform modules for AWS | +| [terraform-aws-starter](https://github.com/nanlabs/terraform-aws-starter) | Jumpstart AWS infra with Terraform | +| [nancy.js](https://github.com/nanlabs/nancy.js) | React components and hooks library | +| [ts-monorepo-boilerplate](https://github.com/nanlabs/ts-monorepo-boilerplate) | TypeScript monorepo starter | +| [automation-seed](https://github.com/nanlabs/automation-seed) | E2E automation with WebdriverIO | +| [aws-glue-etl-boilerplate](https://github.com/nanlabs/aws-glue-etl-boilerplate) | AWS Glue + Spark + Serverless | + +### 🚀 Engineering Labs +| Repository | Purpose | +|---|---| +| [nan-ai-engineering-labs](https://github.com/nanlabs/nan-ai-engineering-labs) | AI/ML experiments and patterns | +| [nan-data-engineering-labs](https://github.com/nanlabs/nan-data-engineering-labs) | Data pipelines and ETL patterns | +| [nan-python-engineering-labs](https://github.com/nanlabs/nan-python-engineering-labs) | Python backend patterns | +| [devsecops-training](https://github.com/nanlabs/devsecops-training) | Security-focused infra training | + +### 🧰 Internal Tools & Skills +| Repository | Purpose | +|---|---| +| [JIRA-Assistant-Skills](https://github.com/nanlabs/JIRA-Assistant-Skills) | Claude Code skills for JIRA automation | +| [Confluence-Assistant-Skills](https://github.com/nanlabs/Confluence-Assistant-Skills) | Claude Code skills for Confluence automation | +| [internal-clickup-mcp-dev-agents-example](https://github.com/nanlabs/internal-clickup-mcp-dev-agents-example) | ClickUp MCP + AI agents integration example | +| [pr-analyzer](https://github.com/nanlabs/pr-analyzer) | PR complexity scoring with LLMs | +| [internal-automation-workflows](https://github.com/nanlabs/internal-automation-workflows) | Internal workflow automation | +| [internal-infra](https://github.com/nanlabs/internal-infra) | Shared internal infrastructure | +| [internal-infra-tools](https://github.com/nanlabs/internal-infra-tools) | Internal infra tooling | +| [internal-terraform-infra](https://github.com/nanlabs/internal-terraform-infra) | Shared Terraform state and modules | +| [internal-skillshouse-app](https://github.com/nanlabs/internal-skillshouse-app) | Internal skillshouse app | +| [skillshouse](https://github.com/nanlabs/skillshouse) | Skills house platform | +| [skillshouse-matcher-api](https://github.com/nanlabs/skillshouse-matcher-api) | Matcher API service | +| [skillshouse-matcher-poc](https://github.com/nanlabs/skillshouse-matcher-poc) | Matcher POC | +| [skillshouse-tracking-api](https://github.com/nanlabs/skillshouse-tracking-api) | Tracking API service | +| [slack-app](https://github.com/nanlabs/slack-app) | NaNLABS Slack app | +| [sops](https://github.com/nanlabs/sops) | GCP KMS secrets utility | + +### 🏗️ Client Projects (Active) +| Repository | Description | +|---|---| +| [chat-engine-api](https://github.com/nanlabs/chat-engine-api) | Chat engine backend (Sendbird replacement) | +| [ev-sap-server](https://github.com/nanlabs/ev-sap-server) | Open e-Mobility charging station backend | +| [project-vintory-*](https://github.com/nanlabs/project-vintory-api) | Vintory platform (api, frontend, infra, cognito) | +| [project-good-apple-*](https://github.com/nanlabs/project-good-apple-api) | Marketing forecasting and ML pipeline | +| [project-trinety-*](https://github.com/nanlabs/project-trinety-quiltt-poc) | Trinety spa backend/frontend POCs | +| [project-uniban-poc](https://github.com/nanlabs/project-uniban-poc) | Uniban ML production forecasting | +| [project-heymirza-pece](https://github.com/nanlabs/project-heymirza-pece) | Heymirza FSM visualization | +| [project-note-go-*](https://github.com/nanlabs/project-note-go-rest-api) | Note-go web app and REST API | +| [project-yellow-pad-*](https://github.com/nanlabs/project-yellow-pad-backend) | Legal document analysis with LLMs | +| [project-thorcast-mlops-*](https://github.com/nanlabs/project-thorcast-mlops-api) | Thorcast MLops API and desktop app | +| [project-restack-medusa-strapi-poc](https://github.com/nanlabs/project-restack-medusa-strapi-poc) | Medusa + Strapi POC | +| [project-nri-otp-poc](https://github.com/nanlabs/project-nri-otp-poc) | NRI OTP Langgraph POC | +| [handoff-poc](https://github.com/nanlabs/handoff-poc) | Handoff POC | +| [handoffs-calendar-syncrhonizer-api-poc](https://github.com/nanlabs/handoffs-calendar-syncrhonizer-api-poc) | Calendar sync POC | +| [project-heymirza-fsm-viz](https://github.com/nanlabs/project-heymirza-fsm-viz) | FSM visualization | +| [cloud-data-engineer-challenge](https://github.com/nanlabs/cloud-data-engineer-challenge) | Take-home challenge | +| [cloud-infrastructure-engineer-challenge](https://github.com/nanlabs/cloud-infrastructure-engineer-challenge) | Take-home challenge | +| [fullstack-engineer-ai-content-workflow-challenge](https://github.com/nanlabs/fullstack-engineer-ai-content-workflow-challenge) | Take-home challenge | +| [fullstack-engineer-music-licensing-workflow-challenge](https://github.com/nanlabs/fullstack-engineer-music-licensing-workflow-challenge) | Take-home challenge | +| [qa-test-automation-engineer-challenge](https://github.com/nanlabs/qa-test-automation-engineer-challenge) | Take-home challenge | + +### 🗂️ Archived / Archived Clients +| Repository | Description | +|---|---| +| [website-v4](https://github.com/nanlabs/website-v4) | Legacy website v4 | +| [website-v5](https://github.com/nanlabs/website-v5) | Legacy website v5 | +| [nan-blog-v5](https://github.com/nanlabs/nan-blog-v5) | Legacy blog | +| [react-boilerplate](https://github.com/nanlabs/react-boilerplate) | React starter (deprecated) | +| [fastapi-boilerplate](https://github.com/nanlabs/fastapi-boilerplate) | FastAPI starter (deprecated) | +| [lamdex-ui](https://github.com/nanlabs/lamdex-ui) | Archived UI components | +| [nameyourpc](https://github.com/nanlabs/nameyourpc) | Archived utility | +| [charting_library](https://github.com/nanlabs/charting_library) | Archived charting package | +| [nan-swat-projects-archive](https://github.com/nanlabs/nan-swat-projects-archive) | NaN SWAT archive (Aegis Vault) | +| [agio-ratings-api](https://github.com/nanlabs/agio-ratings-api) | Archived ratings API | +| [datura-challenge](https://github.com/nanlabs/datura-challenge) | Archived challenge | +| [chat-engine-cassandra](https://github.com/nanlabs/chat-engine-cassandra) | Archived chat engine variant | +| [questionnaire](https://github.com/nanlabs/questionnaire) | Archived questionnaire app | +| [bittensor-subnet-example](https://github.com/nanlabs/bittensor-subnet-example) | Archived Bittensor example | +| [nest-cloud-run](https://github.com/nanlabs/nest-cloud-run) | Archived NestJS Cloud Run POC | +| [typeorm-graphql-nestjs-dataloader-starter-kit](https://github.com/nanlabs/typeorm-graphql-nestjs-dataloader-starter-kit) | Archived starter | +| [rnd-poc-nestjs-nats-microservices](https://github.com/nanlabs/rnd-poc-nestjs-nats-microservices) | Archived NATS POC | +| [rnd-popr-giphy-poc](https://github.com/nanlabs/rnd-popr-giphy-poc) | Archived Giphy POC | +| [redux-thunk-demo](https://github.com/nanlabs/redux-thunk-demo) | Archived Redux demo | +| [react-snap](https://github.com/nanlabs/react-snap) | Archived prerendering framework | +| [rick-morty-frontend-interview](https://github.com/nanlabs/rick-morty-frontend-interview) | Archived interview challenge | +| [Raneto](https://github.com/nanlabs/Raneto) | Archived knowledgebase (forked) | +| [vayda-rscript-job-poc](https://github.com/nanlabs/vayda-rscript-job-poc) | Archived R script POC | +| [10-years-countdown](https://github.com/nanlabs/10-years-countdown) | Archived countdown project | + +--- + +## 🌍 Open Source Projects + +We maintain several public open-source repositories. Contributions are welcome! + +### ⭐ Featured Projects + +| Repository | Description | +|---|---| +| [terraform-aws-modules](https://github.com/nanlabs/terraform-aws-modules) | Reusable Terraform modules for AWS (VPC, EKS, RDS, and more) | +| [terraform-aws-starter](https://github.com/nanlabs/terraform-aws-starter) | Jumpstart AWS infrastructure with Terraform | +| [devops-reference](https://github.com/nanlabs/devops-reference) | Docker, Kubernetes, AWS, Terraform CI/CD patterns | +| [frontend-reference](https://github.com/nanlabs/frontend-reference) | React, TypeScript, Next.js patterns and examples | +| [backend-reference](https://github.com/nanlabs/backend-reference) | Python, Go, Node.js backend patterns | +| [nancy.js](https://github.com/nanlabs/nancy.js) | React component and hook library | +| [ts-monorepo-boilerplate](https://github.com/nanlabs/ts-monorepo-boilerplate) | TypeScript monorepo with Turborepo | +| [automation-seed](https://github.com/nanlabs/automation-seed) | E2E test automation with WebdriverIO | +| [aws-glue-etl-boilerplate](https://github.com/nanlabs/aws-glue-etl-boilerplate) | AWS Glue + Spark + Serverless framework | +| [JIRA-Assistant-Skills](https://github.com/nanlabs/JIRA-Assistant-Skills) | Claude Code skills for JIRA Cloud automation | +| [Confluence-Assistant-Skills](https://github.com/nanlabs/Confluence-Assistant-Skills) | Claude Code skills for Confluence Cloud automation | +| [pr-analyzer](https://github.com/nanlabs/pr-analyzer) | PR complexity scoring and engineering metrics | + +### 📚 Reference Lists +- **[awesome-nan](https://github.com/nanlabs/awesome-nan)** — Curated list of all NaNLABS open-source projects and references + +### 🤝 Sponsored External Projects +| Repository | Description | +|---|---| +| [create-awesome-node-app](https://github.com/Create-Node-App/create-node-app) | Scaffold Node.js apps: web apps, extensions, monorepos | +| [recoil-devtools](https://github.com/ulises-jeremias/recoil-devtools) | Developer tools for Recoil state management | + +--- + +## 📖 Contributing + +See [CONTRIBUTING.md](https://github.com/nanlabs/.github/blob/main/CONTRIBUTING.md) for guidelines on how to contribute to our open-source projects. + +We follow a ** squash-and-merge** policy for clean commit history. + +## 📄 License + +Unless noted otherwise, all open-source projects are released under the [MIT License](https://opensource.org/licenses/MIT). + +--- + +*Maintained by the NaNLABS engineering team.* \ No newline at end of file