Skip to content

Commit

Permalink
refactor: added missing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
abdullahwaheed committed Mar 19, 2024
1 parent 0733e21 commit ecf0e12
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,26 @@ locally. To serve a production build locally:
attempt to run the build on the same port specified in the
`env.config.js` file.

Local module configuration for TypeScript
-----------------------------------------

#. Create file in repository `tsconfig.json`, with a clause `"extends": "@openedx/frontend-build"`
#. Set "rootDir" to the root of the source code folders
#. Set "include" to wildcard patterns specifying the subdirectories/files under rootDir where source code can be found
#. Include any wildcards under rootDir that should be excluded using "exclude"

```Sample json
{
"extends": "@openedx/frontend-build",
"compilerOptions": {
"rootDir": ".",
"outDir": "dist"
},
"include": ["src/**/*"],
"exclude": ["dist", "node_modules"]
}
```

## Development

This project leverages the command line interface for webpack, jest,
Expand Down

0 comments on commit ecf0e12

Please sign in to comment.