Skip to content

Commit

Permalink
added sdlc todo to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vygandas committed Oct 26, 2023
1 parent 9c3c518 commit 04cd3af
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,33 @@
* Create training material to make your start easier.
* Keep UI as simple as possible, so you could choose whether to go with same SCSS, Styled Components, Material UI or Tailwind for your creation

## Technical TODO
## SDLC ToDo

- [ ] Documentation: Getting Started
- [ ] Documentation: Going to Production
- [ ] Training video on how to get started
- [ ] Training video on best practices

## Technical ToDo

- [x] NX monorepo workspace
- [ ] Landing page with Next.js
- [x] Landing page with Next.js
- [ ] CI & Tests
- [ ] Prettier & Linting
- [ ] Generated documentation for API with Compodoc
- [x] Generated documentation for API with Compodoc
- [ ] Swagger for API endpoints
- [ ] DTO as shared lib
- [ ] Redux-toolkit for app data storage
- [ ] Interfaces as shared lib
- [ ] Utils as shared lib (for example time formatting)
- [ ] TypeORM
- [ ] TypeORM & DB migrations
- [ ] Plan a strict rules for timestamps (this is frequent problem for projects where users has to interact across multiple timezones)
- [ ] Connect S3
- [ ] Connect S3 or other object bucket
- [ ] Production Dockerfiles
- [ ] SSL in dev
- [ ] Email solution (prod/dev)
- [ ] SSL in development
- [ ] Transactional emails and templates (prod/dev)
- [ ] Websockets for notifications and updates
- [ ] GDPR compliance
- [ ] DB migrations
- [ ] Easy solution for roles and access management
- [ ] ...

Expand Down

1 comment on commit 04cd3af

@vercel
Copy link

@vercel vercel bot commented on 04cd3af Oct 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.