https://github.com/kirahowe/cljs-new
Create a new minimalist clojurescript project that uses shadow-cljs
https://github.com/kirahowe/cljs-new
Last synced: 2 months ago
JSON representation
Create a new minimalist clojurescript project that uses shadow-cljs
- Host: GitHub
- URL: https://github.com/kirahowe/cljs-new
- Owner: kirahowe
- Created: 2021-03-03T02:17:44.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-06T17:10:22.000Z (about 4 years ago)
- Last Synced: 2025-03-10T12:56:33.071Z (2 months ago)
- Language: HTML
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cljs New
Generate the bare minimum you need for a new Clojurescript app that uses
shadow-cljs. This is _not_ intended to be an opinionated framework for new cljs
projects. The goal is simply to have a single command you can run to generate
the scaffolding without needing to create a bunch of files manually to get
started with cljs.
## Quickstart
npx cljs-new my-app-name
cd my-app-name
yarn dev
Navigate to http://localhost:3000 to see your app. The boilerplate html you see
is in `public/index.html`.
To deploy to production, create a minified bundle with `yarn build`.
## Features
- No opinionated defaults. This creates a new project with no dependencies and makes no assumptions about how you will structure your app. It only sets up the bare minimum build chain required to start a new clojurescript project.
- [Chrome cljs devtools](https://github.com/binaryage/cljs-devtools) are included and configured, which allows you to work with clojurescript directly in the Chrome devtools.
- **shadow-cljs uses [namespace dependency graphs](https://shadow-cljs.github.io/docs/UsersGuide.html#_dependencies) to determine what code is needed in the final output, so there is no need to specify dev dependencies separately**
- `dev`, `compile`, `release`, `browser-repl`, `node-repl`, and `test` commands already configured and ready to run with one command
## Usage
Creating a new app (with `npx cljs-new my-app-name`) will create the following
files in a directory called `my-app-name`:
my-app-name
├── .gitignore
├── README.md
├── package.json
├── shadow-cljs.edn
├── public
| ├── css
| | └── style.css
| ├── index.html
| └── favicon.ico
└── src
└── app
└── main.cljs
## Dependencies
You need node (a JavaScript runtime) and npm v5.2+ (a JavaScript package
manager, and more) installed on your machine. npm comes with node. [Here are
the node installation instructions](https://nodejs.org/en/download/package-manager/#macos).