Penpot/penpot
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-01-08 16:00:19 -05:00
Code Issues Activity

Update readme.

Browse source
This commit is contained in:
Andrey Antukh 2016-01-20 18:48:23 +02:00
parent 2f39cc08dc
commit 7327bfba76
1 changed files with 5 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -1,23 +1,17 @@
# UXBox #
[![Travis Badge](https://img.shields.io/travis/uxbox/front.svg?style=flat)](https://travis-ci.org/uxbox/front "Travis Badge (frontend)")
[![Travis Badge](https://img.shields.io/travis/uxbox/back.svg?style=flat)](https://travis-ci.org/uxbox/back "Travis Badge (backend)")
## Development ##
### Frontend ###
Grab the code and run:
```
$ lein with-profile +front figwheel
$ ./scripts/figwheel
```
This will compile ClojureScript whenever you make changes and serve the application in [localhost](http://localhost:3449/).
Open the page.
#### ClojureScript browser-connected REPL ####
### ClojureScript browser-connected REPL ###
The aforementioned command also starts a [nrepl](https://github.com/clojure/tools.nrepl) (network REPL) in the port 7888.
@ -40,7 +34,8 @@ user> (cljs-repl)
After that, a figwheel message will appear and the prompt will change to `cljs.user>`. We can now evaluate ClojureScript in the
browser from the REPL.
#### Static resources generation ####
### Static resources generation ###
The project's static resources are processed using [gulp](http://gulpjs.com/). First of all, install the npm dependencies running:
@ -60,25 +55,8 @@ To process the resources just once, run:
npm run dist
```
#### Testing ####
For running the tests from a shell, run the following command:
```
$ lein cljsbuild once test
```
If you want to run the tests from a ClojureScript REPL, you can do it like so (given that you want to run the tests contained in the `uxbox.core-test` namespace):
```
cljs.user> (require '[cljs.test :as t])
cljs.user> (t/run-tests 'uxbox.core-test)
```
Note that the test output will appear in the browser and in the shell where you launched the `lein fighweel` command.
#### Transformation from HTML to hiccup ####
### Transformation from HTML to hiccup ###
For transforming the generated HTMLs to hiccup form, execute the following command:
@ -88,34 +66,6 @@ $ lein with-profile +front hicv 2clj resources/public/templates/*.html
The `.clj` files in the `hicv` directory will contain the hiccup versions of the HTML templates.
### Backend ###
#### REPL ####
You can start a Clojure REPL with the following command:
```
$ lein repl
```
In Emacs you can use [cider's](https://github.com/clojure-emacs/cider) `M-x cider-jack-in` command in the proyect directory
to have a REPL in your editor.
#### Testing ####
For running the tests from a shell, run the following command:
```
$ lein test
```
If you want to run the tests from a Clojure REPL, you can do it like so (given that you want to run the tests contained in the `uxbox.core-test` namespace):
```
user> (require '[clojure.test :as t])
user> (t/run-tests 'uxbox.core-test)
```
## License ##