CDS-TS-Dispatcher dev container

The CDS-TS-Dispatcher dev container repository contains the CDS-TS-Dispatcher & CDS-TS-Repository and all dependencies needed to boot a new project :

Tools installed inside of the container :

• Controller - Service - Repository project structure folders :
  • controller
  • service
  • repository
  • middleware
  • util
  • test
• ESLint, Prettier
• VSCode Extensions best extensions for SAP CAP TypeScript development
• Cloud MTA Build tool for building MTA file
• Cloud Foundry CLI (CF)
• Git, Cds, Npm, Node
• CDS-Typer for building typescript entities out of CDS files
• tsconfig.json, .eslintrc, .prettierrc, .gitignore - predefined properties
• package.json - predefined scripts
• Linux OS

Table of Contents

• CDS-TS-Dispatcher dev container
  • Table of Contents
  • Installation
    • Docker & VSCode - (local development)
    • SAP Business Application Studio - (BAS)
  • Contributing
  • License
  • Authors

Installation

Docker & VSCode - (local development)

1. Install Docker desktop
2. Clone CDS-TS-Dispatcher container using below command :

git clone /~https://github.com/dxfrontier/cds-ts-dispatcher-dev-container

3. Open project in VSCode using:

code cds-ts-dispatcher-dev-container

4. Change GIT remote origin to your origin

git remote remove origin
git remote add origin /~https://github.com/user/YOUR_GIT_REPOSITORY.git
git branch -M main
git push -u origin main

5. Install Remote development pack VScode extension

6. COMMAND + SHIFT + P on MacOS or CTRL + SHIFT + P on Windows

   1. Type - Rebuild and Reopen in Container - This step will start creating the container project and start the Node server.

7. Start development as usual.

(back to top)

SAP Business Application Studio - (BAS)

1. Clone CDS-TS-Dispatcher container using below command :

git clone /~https://github.com/dxfrontier/cds-ts-dispatcher-dev-container

2. Change GIT remote origin to your origin

git remote remove origin
git remote add origin /~https://github.com/user/YOUR_GIT_REPOSITORY.git
git branch -M main
git push -u origin main

3. Install the following npm packages

npm install -g typescript ts-node

4. Start development as usual.

npm start

(back to top)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

Copyright (c) 2024 DXFrontier

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Authors

• @dragolea
• @sblessing
• @mathiasvkaiz
• @ABS GmbH team

(back to top)