From b9f65035132beaa1c59e53646d61f1395a92fd34 Mon Sep 17 00:00:00 2001 From: Katja Lutz Date: Wed, 22 Jun 2022 18:40:51 +0200 Subject: [PATCH] docs: add README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..83d1345 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# [Räppli](https://rappli.ch) + +[](https://rappli.ch) + +## Developing + +Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: + +```bash +npm run dev + +# or start the server and open the app in a new browser tab +npm run dev -- --open +``` + +## Building + +Solid apps are built with _adapters_, which optimise your project for deployment to different environments. + +By default, `npm run build` will generate a Node app that you can run with `node build`. To use a different adapter, add it to the `devDependencies` in `package.json` and specify in your `vite.config.js`. + +## Powered by solid-start + +Everything you need to build a Solid project, powered by [`solid-start`](https://github.com/ryansolid/solid-start/tree/master/packages/solid-start); \ No newline at end of file