Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.02 KB

README.md

File metadata and controls

47 lines (32 loc) · 2.02 KB

🚀 s1m-monorepo-starter

⚙️ WIP

quality gate MIT

🩲 Trunk-Based Development (Branching Model)

This project is based on a source-control branching model, where collaboration on code is bundled in a single branch called ‘trunk’ (dev). Read more about trunk-based development here.

🥒 Behavior-Driven Development (BDD)

In BDD, you write your system requirements in natural language. This makes them easier to read and use. Basic .feature files are written with Gherkin syntax. User stories and use cases are based on the same structure, so feature files help stakeholders understand user flows and scenarios. They can also be used for automated tests.

🎯 Features

📦 Nx - monorepo tooling
🛠️ Angular 18 - front-end framework
🎨 Material UI - UI component library
⚛️ NGRX - reactive-state management
📦 NestJS 9 - api/back end (and mocking data)
🧪 Jest - unit testing
🖼️ Playwright - e2e testing
🔤 ESLint - code linting
🔤 Prettier - code formatting
💾 Vercel - front-end deployment
💾 Serverless & AWS Lambda - back-end deployment

🛫 Get Started

👩‍💻 Development

↘️ Deployment

🖼️ Front End - Vercel

🍑 Back End - AWS Lambda

📥 TODOs

  • Add development section
  • Add deployment section
  • Add unit test examples
  • Add e2e test examples
  • Add github actions to deploy back end to serverless