https://github.com/rajasegar/cl-caveman-tailwind
Common Lisp Web application boilerplate using Caveman and Tailwind CSS
https://github.com/rajasegar/cl-caveman-tailwind
boilerplate boilerplate-template caveman2 common-lisp lisp tailwindcss
Last synced: 3 months ago
JSON representation
Common Lisp Web application boilerplate using Caveman and Tailwind CSS
- Host: GitHub
- URL: https://github.com/rajasegar/cl-caveman-tailwind
- Owner: rajasegar
- Created: 2021-07-07T02:03:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-07T02:37:13.000Z (almost 4 years ago)
- Last Synced: 2025-02-09T02:22:15.315Z (5 months ago)
- Topics: boilerplate, boilerplate-template, caveman2, common-lisp, lisp, tailwindcss
- Language: HTML
- Homepage: https://cl-caveman-tailwind.herokuapp.com
- Size: 331 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
# cl-caveman-tailwind
Common Lisp web application boilerplate using [Caveman](https://github.com/fukamachi/caveman) and [Tailwind CSS](https://tailwindcss.com)
## Pre-requisites
You need [Node.js](https://nodejs.org) installed in your machine, since the build scripts for Tailwind CSS require the `npx` program.
## Usage
```lisp
(ql:quickload :cl-caveman-tailwind)
(cl-caveman-tailwind:start :port 3000)
```
## Installation
You can clone the repo
```
git clone https://github.com/rajasegar/cl-caveman-tailwind
```
Or, you can use something like [degit](https://github.com/Rich-Harris/degit)
```
degit rajasegar/cl-caveman-tailwind#main
```
degit makes copies of git repositories. When you run degit, it will find the latest commit and download the associated tar file. (This is much quicker than using git clone, because you're not downloading the entire git history.)
**NOTE:** Please ensure you change the name of the system definitions, packages and other relevant places by replacing the default name `cl-caveman-tailwind`.
## Building CSS
There is a script file `build-css.sh` for building dev and prod environment CSS assets.
For development environment
```
./build-css.sh
```
For production environment, you need to pass in the `--prod` flag
```
./build-css.sh --prod
```
## Adding custom css
Since you are using Tailwind CSS you most probably don't need any custom css, because Tailwind has got a ton of utility classes
you can directly use. But if you feel the need to add custom css, just append them to the file `src/tailwind.css`.
The build scripts will take this file, compile and produce the output css into `static/css/main.css`.
## Author
* Rajasegar Chandran
## Copyright
Copyright (c) 2021 Rajasegar Chandran