Skip to content

Commit

Permalink
docs: update .md files
Browse files Browse the repository at this point in the history
  • Loading branch information
olehmelnyk committed Apr 19, 2023
1 parent 5f9edf0 commit f1047d4
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 4 deletions.
58 changes: 58 additions & 0 deletions FEATURES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Features

## Auth

- [ ] JWT tokens
- [ ] email + password + Google Authenticator 2fa
- [ ] Google auth
- [ ] Facebook auth
- [ ] Apple auth
- [ ] Microsoft auth
- [ ] Twitter auth
- [ ] Role Based Access Control

## Admin Dashboard

## Caching and rate limiting w/ Redis

## Notifications

- [ ] in-app (in browser tab)
- [ ] descktop (outside the browser)
- [ ] push (mobile)
- [ ] email
- [ ] messager (slack, discord, telegram, viber, FB Messanger, Skype, WhatsApp...)

## Send emails

- [ ] Postmark
- [ ] Nodemailer
- [ ] SES
- [ ] SendGrid

## Upload files

- [ ] AWS S3 upload

## Live chat

## Blog

- [ ] CMS

## Store

- [ ] accept paymets via Stripe
- [ ] accept paymets via PayPal

## Support system

- [ ] report bug / request feature (for users)
- [ ] JIRA-like board with requests (for support)

## KYC

## CI/CD

- [ ] GitHub Actions
- [ ] Terraform
21 changes: 17 additions & 4 deletions STACK.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,15 @@ _plus more:_
- [x] Code formatter: [Prettier](https://prettier.io/)
- [x] Code linting: [ESLint](https://eslint.org/)
- [x] [eslint-plugin-tailwindcss](https://github.com/francoismassart/eslint-plugin-tailwindcss)
- [x] Code linting: [SonarLint](https://www.sonarsource.com/products/sonarlint/) (added as recommended VSCode extension)
- [ ] Static code analysis: [SonarQube](https://www.sonarsource.com/products/sonarqube/)
- [ ] Sonar
- [x] Code linting: [SonarLint](https://www.sonarsource.com/products/sonarlint/) (added as recommended VSCode extension)
- [ ] Static code analysis: [SonarQube](https://www.sonarsource.com/products/sonarqube/)
- [x] Git Commit messages: [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) & [lintcommit](https://commitlint.js.org/)
- [x] Git Branch Name Convesions: [validate-branch-name](https://github.com/JsonMa/validate-branch-name#readme)
- [ ] Code monitoring, logging and alerting: [Sentry](https://sentry.io/welcome/)
- [ ] System metrics, monitoring and alerting [Prometheus](https://prometheus.io/) + [Grafana](https://grafana.com/)
- [ ] Code monitoring, logging and alerting:
- [ ] [Sentry](https://sentry.io/welcome/)
- [ ] [Checkly](https://www.checklyhq.com/) (e2e, monitoring & alerting, uses Playwright for e2e)
- [ ] System metrics, monitoring and alerting [Prometheus](https://prometheus.io/) + [Grafana](https://grafana.com/)
- [ ] Vulnerabilities checks
- [ ] [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)
- [ ] [Snyk](https://snyk.io/)
Expand Down Expand Up @@ -130,3 +133,13 @@ _plus more:_
# Useful resources:

- [NPM Trends](https://npmtrends.com/) can be used if you need to complare multiple npm packages to pick from

# Tool preferences

- [npm](https://www.npmjs.com/) > [yarn](https://yarnpkg.com/) > ✅ [pnpm](https://pnpm.io/)
- [webpack](https://webpack.js.org/) > [vite](https://vitejs.dev/) > ✅ [turbopack](https://turbo.build/pack)
- [lerna](https://lerna.js.org/) > [nx](https://nx.dev/) > ✅ [turborepo](https://turbo.build/repo)
- [jest](https://jestjs.io/) > ✅ [vitest](https://vitest.dev/)
- [selenium](https://www.selenium.dev/) > [cypress](https://www.cypress.io/) > ✅ [playwright](https://playwright.dev/)
- [nvm](https://github.com/nvm-sh/nvm) > ✅ [volta](https://volta.sh/)
- [create-react-app](https://www.npmjs.com/package/create-react-app) > [create-next-app](https://www.npmjs.com/package/create-next-app) > [create-t3-app](https://github.com/t3-oss/create-t3-app) > [create-t3-turbo](https://github.com/t3-oss/create-t3-turbo) > ✅ [dreamstack](https://github.com/olehmelnyk/dream-stack)

1 comment on commit f1047d4

@vercel
Copy link

@vercel vercel bot commented on f1047d4 Apr 19, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

dream-stack – ./

dream-stack-git-main-olehmelnyk.vercel.app
dream-stack.vercel.app
dream-stack-olehmelnyk.vercel.app

Please sign in to comment.