Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme.md #66

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme.md #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,36 @@ Start use now and just focus on your business and not spending hours in project
- **Queue Jobs** thanks to [BullMQ](https://github.com/taskforcesh/bullmq).
- **Query Parser** thanks to [Typeorm Query Parser](https://github.com/gentritabazi01/typeorm-simple-query-parser).

### Project Structure
```dist/ Compiled source files will be placed here
src/ Source files
|-- config/ The config directory, as the name implies, contains all of your application's configuration files.
|-- api/
| |-- controllers/ REST API Controllers
| |-- responses/ Response classes or interfaces to type JSON response bodies
| |-- exceptions/ Custom HttpErrors like 404 NotFound
| |-- models/ TypeORM Models
| |-- repositories/ Repository / DB layer
| |-- services/ Service layer
| |-- events/ Events
| |-- requests/ Request classes with validation rules if the body is not equal with a model
| |-- transformers/ Class-transformer allows you to transform plain object to some instance of class and versa
| |-- cron-jobs/ Cron Jobs
| |-- resolvers/ GraphQL resolvers (query, mutation & field-resolver)
| |-- types/ GraphQL types, input-types and scalar types
| |-- queue-jobs/ Queue Jobs
|-- infrastructure/ App Infrastructure
| |-- middlewares/ Express Middlewares
|-- database/
| |-- factories/ Factory to generate fake entities
| |-- migrations/ Database migration scripts
| |-- seeds/ Seeds to create some data in the database
|-- decorators/ Custom decorators like @EventDispatch
|-- public/ Static assets (fonts, css, js, img).
.env.example Environment configurations
```


### Documentation

https://kutia-software-company.github.io/express-typescript-starter
Expand Down