Udated readme, minor polishing

This commit is contained in:
ireic
2020-01-23 19:33:56 +01:00
parent d4b4624250
commit fffb0fed4f
6 changed files with 34 additions and 4 deletions

View File

@@ -10,7 +10,28 @@
![Tech logos](https://i.ibb.co/0BgNRKC/logos.jpg)
![App screenshot](https://i.ibb.co/HDwwh6L/jira-clone-optimized.jpg)
![App screenshot](https://i.ibb.co/W3qVvCn/jira-optimized.jpg)
## What is this and who is it for 🤷‍♀️
I do web development and UX design consulting and this is a showcase product I've built in my spare time. It's a very good example of what a modern real-world React codebase looks like.
There are many public React projects out there but most of them are either way too simple or [way too complex](https://github.com/Automattic/wp-calypso). I like to think that this project contains enough complexity to offer valuable insights to React developers of all skill levels while still being relatively easy to understand.
## Features
### Client
- Proven, scalable, and easy to understand project structure
- Written in modern React, only functional components with hooks
- A variety of custom light-weight UI components such as datepicker, modal, various form elements etc
- Simple local React state management, without redux, mobx, or similar
- Custom webpack/babel setup, without create-react-app or similar
### API
- Simple, scalable, and easy to understand project structure
- Written in TypeScript and using TypeORM
## Setting up development environment 🛠