Skip to content

Commit 65df6d4

Browse files
author
William Troup
authored
Merge pull request #25 from williamtroup/2.0.0
2.0.0
2 parents 7488db9 + 1f84dc2 commit 65df6d4

File tree

99 files changed

+6870
-2972
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+6870
-2972
lines changed

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
/.vs
22
/.vscode
33
.DS_Store
4-
*.nupkg
4+
*.nupkg
5+
/build
6+
/node_modules

‎.npmignore

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
/.github
2+
/.vscode
3+
/test
4+
/build
5+
CODE_OF_CONDUCT.md
6+
CONTRIBUTING.md
7+
journey.js.nuspec
8+
PACK.sh
9+
PUBLISH.sh
10+
README_NUGET.md
11+
SECURITY.md
12+
SERVE.sh
13+
package-lock.json
14+
tsconfig.json
15+
tsup.build.config.ts
16+
tsup.build.esm.config.ts
17+
tsup.build.min.config.ts
18+
BUILD_INSTRUCTIONS.md
19+
*.nupkg

‎BUILD_INSTRUCTIONS.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Building Journey.js v2.0.0
2+
3+
Before getting started with Journey.js, please read through the following instructions:
4+
5+
6+
## Step 1: Install Packages:
7+
8+
Install the packages using the following NPM commands:
9+
10+
### 1. Install TypeScript:
11+
12+
```markdown
13+
npm install -g typescript
14+
```
15+
16+
### 2. Install tsup:
17+
18+
```markdown
19+
npm i tsup -D
20+
```
21+
22+
### 3. Install terser:
23+
24+
```markdown
25+
npm install terser -D
26+
```
27+
28+
### 4. Install swc/core (if ES5 is required):
29+
30+
```markdown
31+
npm install @swc/core -D
32+
```
33+
34+
35+
## Step 2: Build Project:
36+
37+
### 1. Full Build:
38+
39+
To build the TypeScript, run the following command:
40+
41+
```markdown
42+
npm run build-typescript
43+
```
44+
45+
To build the SASS, run the following command:
46+
47+
```markdown
48+
npm run build-sass
49+
```
50+
51+
To build the everything, run the following command:
52+
53+
```markdown
54+
npm run build
55+
```
56+
57+
### 2. Minimized Build:
58+
59+
To build the TypeScript, run the following command:
60+
61+
```markdown
62+
npm run build-minimized-typescript
63+
```
64+
65+
To build the SASS, run the following command:
66+
67+
```markdown
68+
npm run build-minimized-sass
69+
```
70+
71+
To build the everything, run the following command:
72+
73+
```markdown
74+
npm run build-minimized
75+
```
76+
77+
### 3. ESM Build:
78+
79+
To build the TypeScript, run the following command:
80+
81+
```markdown
82+
npm run build-typescript-esm
83+
```

‎README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
Journey.js
33

44
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Journey.js%2C%20a%20free%20JavaScript%journey%builder&url=https://github.com/williamtroup/Journey.js&hashtags=javascript,html,journey,guide)
5-
[![npm](https://img.shields.io/badge/npmjs-v1.7.2-blue)](https://www.npmjs.com/package/jjourney.js)
6-
[![nuget](https://img.shields.io/badge/nuget-v1.7.2-purple)](https://www.nuget.org/packages/jJourney.js/)
5+
[![npm](https://img.shields.io/badge/npmjs-v2.0.0-blue)](https://www.npmjs.com/package/jjourney.js)
6+
[![nuget](https://img.shields.io/badge/nuget-v2.0.0-purple)](https://www.nuget.org/packages/jJourney.js/)
77
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Journey.js/blob/main/LICENSE.txt)
88
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Journey.js/discussions)
99
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://www.william-troup.com/)
1010
</h1>
1111

1212
> <p align="center">🚶 A lightweight, easy-to-use JavaScript library to create interactive, customizable, accessible guided tours across your websites or web apps!</p>
13-
> <p align="center">v1.7.2</p>
13+
> <p align="center">v2.0.0</p>
1414
<br />
1515
1616
![Journey.js](docs/images/main.png)
@@ -21,7 +21,7 @@ Journey.js
2121
<h1>What features does Journey.js have?</h1>
2222

2323
- Zero-dependencies and extremely lightweight!
24-
- Exportable for use in other frameworks!
24+
- Written in TypeScript, allowing greater support for React, Angular, and other libraries!
2525
- Full API available via public functions.
2626
- Fully styled in CSS/SASS and compatible with the Bootstrap library.
2727
- Full CSS theme support (using :root variables, with a default dark-mode theme).
@@ -125,6 +125,13 @@ npm install jjourney.js
125125
```
126126

127127
Or, you can download the latest zipped up version [here](https://www.william-troup.com/journey-js/download.html).
128+
129+
Or, you can also use the following CDN links:
130+
131+
```markdown
132+
https://cdn.jsdelivr.net/gh/williamtroup/Journey.js@main/dist/journey.min.js
133+
https://cdn.jsdelivr.net/gh/williamtroup/Journey.js@main/dist/journey.js.min.css
134+
```
128135
<br>
129136
<br>
130137

‎README_NUGET.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Journey.js v1.7.2
1+
# Journey.js v2.0.0
22

33
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Journey.js%2C%20a%20free%20JavaScript%journey%builder&url=https://github.com/williamtroup/Journey.js&hashtags=javascript,html,journey,guide)
4-
[![npm](https://img.shields.io/badge/npmjs-v1.7.2-blue)](https://www.npmjs.com/package/jjourney.js)
5-
[![nuget](https://img.shields.io/badge/nuget-v1.7.2-purple)](https://www.nuget.org/packages/jJourney.js/)
4+
[![npm](https://img.shields.io/badge/npmjs-v2.0.0-blue)](https://www.npmjs.com/package/jjourney.js)
5+
[![nuget](https://img.shields.io/badge/nuget-v2.0.0-purple)](https://www.nuget.org/packages/jJourney.js/)
66
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Journey.js/blob/main/LICENSE.txt)
77
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Journey.js/discussions)
88
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://www.william-troup.com/)
@@ -13,7 +13,7 @@
1313
## What features does Journey.js have?
1414

1515
- Zero-dependencies and extremely lightweight!
16-
- Exportable for use in other frameworks!
16+
- Written in TypeScript, allowing greater support for React, Angular, and other libraries!
1717
- Full API available via public functions.
1818
- Fully styled in CSS/SASS and compatible with the Bootstrap library.
1919
- Full CSS theme support (using :root variables, with a default dark-mode theme).
@@ -110,6 +110,13 @@ npm install jjourney.js
110110

111111
Or, you can download the latest zipped up version [here](https://www.william-troup.com/journey-js/download.html).
112112

113+
Or, you can also use the following CDN links:
114+
115+
```markdown
116+
https://cdn.jsdelivr.net/gh/williamtroup/Journey.js@main/dist/journey.min.js
117+
https://cdn.jsdelivr.net/gh/williamtroup/Journey.js@main/dist/journey.js.min.css
118+
```
119+
113120

114121
## How do I get started?
115122

‎dist/journey.d.mts

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
export { }

‎dist/journey.d.ts

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
export { }

0 commit comments

Comments
 (0)