Skip to content
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
30 changes: 30 additions & 0 deletions Onboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# BCAN Dev Resource Page

## Technology Preface

<br>

**SatchelJS**: [Satchel Documentation](https://microsoft.github.io/satcheljs/book/)

Satchel is the dataflow framework we use in this repository. It builds on top of the Flux architecture and uses **MobX** under the hood for reactive state management. More info on designing reactive frontend components with Satchel/MobX is in the **/frontend/README.md**

**NestJS**: [NestJS Documentation](https://docs.nestjs.com/)

NestJS is our framework that helps to modularize service, model, controller, (and module) design in the backend. More info on designing a nest directory is in the **/backend/README.md.**

**AWS Services**: [DynamoDB Documentation](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html)

We use AWS services such as Cognito and DynamoDB for authentication and database operations respectively. Refer to online material surrounding the ecosystem or some other Nest modules we already have set up!

---
<br>

## Testing

<br>

**Frontend**: Vitest with React Testing Library
<br>
**Backend**: Vitest

Both repositories use npm run test
Loading
Loading