reiver
/
asan-js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md

master
Charles Iliya Krempeaux 2023-11-16 05:01:12 -08:00
parent b5c9c542d7
commit 372f1624f3
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,12 +1,20 @@
# asan.js # asan.js
**asan.js** is a **convention-over-configuration** model-view system for web-sites and web-applications. **asan.js** is a **convention-over-configuration** style **model-view** system for web-sites and web-applications.
The attaction of using **asan** is that the location of the **model** for a path is very straight-forward The attaction of using **asan** is that the location of the **model** for a path is very straight-forward.
For example, the **model** for a path "`/an/example/path`" would be at "`/src/an/example/path`". For example, the **model** for a path "`/an/example/path`" would be at "`/src/an/example/path`".
I.e., a "`/src`" prefix is added to the current path to get the **model**. I.e., a "`/src`" prefix is added to the current path to get the **model**.
Since **asan** is **convention-over-configuration**, it takes care of all this for you.
**asan** infers what the current path is.
(Ex: "`/apple/banana/cherry.html`".)
And then **asan** calculates the path of the **model** (based of the current path).
(Ex: "`/src/apple/banana/cherry.html`".)
And then includes that.
You just have to tel it _where_ to include it.
## Example ## Example
Here is an example usage of **asan.js**: Here is an example usage of **asan.js**:
@ -19,6 +27,8 @@ Here is an example usage of **asan.js**:
<script type="module"> <script type="module">
import * as asan from "./asan.js" // <--- Your path of asan.js might be different. import * as asan from "./asan.js" // <--- Your path of asan.js might be different.
// In this example code, we are going to tell asan to include the view under the element with id="main".
// In your code you could do something else.
const element = document.getElementById("main") const element = document.getElementById("main")
asan.include(element) asan.include(element)