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.

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

Add more core libraries and update scripts for running jest and webpack and mocks #1

Merged
merged 4 commits into from
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"env": {
"test": {
"plugins": ["@babel/plugin-transform-modules-commonjs"]
}
}
}
8 changes: 4 additions & 4 deletions MIT.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Copyright 2021, [YOUR NAME]
## Copyright 2021, Esteban Palacios

###### Please delete this line and the next one
###### APP TYPE can be a webpage/website, a web app, a software and so on

Permission is hereby granted, free of charge, to any person obtaining a copy of this [APP TYPE] and associated documentation files, to deal in the [APP TYPE] without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the [APP TYPE], and to permit persons to whom the [APP TYPE] is furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of this Webpack Template and associated documentation files, to deal in the Webpack Template without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Webpack Template, and to permit persons to whom the Webpack Template 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 [APP TYPE].
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Webpack Template.

THE [APP TYPE] 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 [APP TYPE] OR THE USE OR OTHER DEALINGS IN THE [APP TYPE].
THE Webpack Template 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 Webpack Template OR THE USE OR OTHER DEALINGS IN THE Webpack Template.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,21 +85,30 @@ To get a local copy up and running, follow these steps.

To run this project you need:

- VSCode
- npm
- Node

### Setup

Acquire a Web browser
Make sure you have VSCode, npm, and Node installed

### Install
No installation is needed.
In the root folder, run the script `npm install` to install all the libraries necessary.

### Usage
#### Webpack
- Run the scripts: `npm run watch-webpack` to only have Webpack watch your files or
- `npm run watch` to watch the tests and Webpack changes
#### Live Demo
- Run the script `npm run start` to see a live version of the project

To start the page run your command line:
- `npm install`
- `npm run start`

### Run tests

Use your browser's developer tools
Use the scripts:
- `npm run watch-jest` to only watch your tests with Jest or
- `npm run watch` to watch the tests and Webpack changes

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down Expand Up @@ -129,7 +138,7 @@ Use your browser's developer tools

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page UPDATE URL HERE](https://github.com/Estete9/YOUR-REPO-NAME-HERE/issues).
Feel free to check the [issues page UPDATE URL HERE](https://github.com/Estete9/webpack-template/issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand All @@ -153,6 +162,6 @@ If you like this project remember to star and share it 🥳️

## 📝 License <a name="license"></a>

This project is [MIT](./MIT.md) licensed.
This project is [MIT](./MIT.md)-licensed.

<p align="right">(<a href="#readme-top">back to top</a>)</p>
1 change: 1 addition & 0 deletions __mocks__/svgMock.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = 'svg-mock';
Loading