https://github.com/researchsquare/delivery-scripts
A Delivery team UI build scripts and toolkit
https://github.com/researchsquare/delivery-scripts
delivery
Last synced: about 1 month ago
JSON representation
A Delivery team UI build scripts and toolkit
- Host: GitHub
- URL: https://github.com/researchsquare/delivery-scripts
- Owner: researchsquare
- Created: 2022-03-03T16:16:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T12:26:57.000Z (over 1 year ago)
- Last Synced: 2026-01-03T22:38:08.067Z (5 months ago)
- Topics: delivery
- Language: JavaScript
- Homepage:
- Size: 498 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# delivery-scripts
A build toolkit built and maintained by the Delivery engineering team. This is kinda like `react-scripts` and inspired by `paypal-scripts`.
# Why?
We maintain several different applications that have custom build tooling. Managing all of those dependencies in each project was getting out of hand and we found ourselves frequently
copy/pasting config between the projects.
# Principles
- Hide internals and expose an easy API that can evolve over the years
- Developer experience above everything else (including performance if it comes down to that)
- Easy to upgrade
- Remove bloated dependency trees in client code
## Installation
```bash
yarn add @researchsquarecompany/delivery-scripts
```
## Usage/Examples
Add a `ds.config.js` to the root of your application
```
module.exports = {
outputPath: "dist/",
manifestPath: "dist/",
entry: {
index: "./src/index.js",
},
};
```
## Documentation
### outputPath
This is the folder where the built and bundled assets will end up.
### manifestPath
This is the folder where a manifest file will be generated upon successfull build.
### entry
An object of key values where the key will generate the name of the bundled file and the value is the location of the file you want to bundle.