https://github.com/pxls00/shop-now-api

Shop-now-api v3.0.0
https://github.com/pxls00/shop-now-api

express mongoose swagger testing typescript

Last synced: about 12 hours ago
JSON representation

Shop-now-api v3.0.0

• Host: GitHub
• URL: https://github.com/pxls00/shop-now-api
• Owner: pxls00
• Created: 2023-06-14T15:19:11.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-13T16:03:16.000Z (about 1 year ago)
• Last Synced: 2023-11-14T12:07:54.564Z (about 1 year ago)
• Topics: express, mongoose, swagger, testing, typescript
• Language: TypeScript
• Homepage:
• Size: 847 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
File system [Feature-sliced-design]

- src/

    - **tests** — [*tests, module and integration tests*]

    - models — [*mongoose models*]

    - lib — [*configuration of this api*]

    - router — [inits all route files from different sections]

    - utils — [*functions that starts this project, and most commonly used helpers in this project*]

    - main.ts — [*init functions that helps to start the project*]

    - marketplace/

        - router/index.ts — [*main router file of marketplace section, init all module routes, and has access to controllers*]

        - utils — [*main helper functions, or init option of necessary services, such as swagger or etc.* ]

        - types — [*essential types to all modules*]

        - middleware — [*middleware functions that used in this part of api*]

        - services — [*classes with function that has access to models*]

        - controllers — [*classes with function that has access to services*]

        - modules — [*module that does one bf*]

            - lib - [*configuration variables for one module*]

            - middlewares - [*middleware function for one module*]

            - routers - [*routes for one module, has access to controllers from outside ../../controllers/**]

            - utils- [*helper functions, or mini service configurations*]

            - swagger - [swagger api for one module]

            - index.ts - ***public api***

    - company-admin/

    - main-admin/

- .husky — [*commit hooks configuration*]

- .github — [*configuration workflows (cd)*]

Rules:

- For every feature despite fix bugs, open them own branch

- After completing feature commit them, commit pre-hook works and it fixes lint errors

- Try to write clean code, [DRY, KISS]