excellalabs / excellalabs/tcp-react-typescript
Update README to be more informative
Open
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
The README file should have detailed structured content like the one for TCP-Angular: https://github.com/excellaco/tcp-angular/blob/master/README.md
Breakdown:
1. Quickstart
2. Deploy Instructions (Are we sticking with CircleCI or update to AWS?)
3. Architecture Breakdown (Explain file structure)
4. Auth and JWT breakdown
5. Forms (Formik: https://formik.org/)
6. CRUD services (and BaseCrudService)
7. Routing
8. Style (Material-ui)
9. Testing (@testing-library/react)
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.