mirror of
https://github.com/MbinOrg/mbin-website.git
synced 2025-07-05 01:28:57 +00:00
Add Mbin favicon and simplify readme dev instructions
This commit is contained in:
parent
6414e29260
commit
e118d9d5cd
3 changed files with 8 additions and 26 deletions
32
README.md
32
README.md
|
@ -1,32 +1,14 @@
|
||||||
# SolidStart
|
# Mbin Website
|
||||||
|
|
||||||
Everything you need to build a Solid project, powered by [`solid-start`](https://start.solidjs.com);
|
## Contributing
|
||||||
|
|
||||||
## Creating a project
|
This website is built with [Solid.js](https://www.solidjs.com), [SolidUI](https://www.solid-ui.com), and [Tailwind CSS](https://tailwindcss.com).
|
||||||
|
|
||||||
|
Once you've cloned the repo and installed dependencies with `pnpm install`, start a development server:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# create a new project in the current directory
|
pnpm dev
|
||||||
npm init solid@latest
|
|
||||||
|
|
||||||
# create a new project in my-app
|
|
||||||
npm init solid@latest my-app
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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
|
# or start the server and open the app in a new browser tab
|
||||||
npm run dev -- --open
|
pnpm dev -- --open
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
Solid apps are built with _presets_, which optimise your project for deployment to different environments.
|
|
||||||
|
|
||||||
By default, `npm run build` will generate a Node app that you can run with `npm start`. To use a different preset, add it to the `devDependencies` in `package.json` and specify in your `app.config.js`.
|
|
||||||
|
|
||||||
## This project was created with the [Solid CLI](https://solid-cli.netlify.app)
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
"name": "mbin-website",
|
"name": "mbin-website",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "vinxi dev",
|
"dev": "pnpm run initdata && vinxi dev",
|
||||||
"build": "pnpm run initdata && vinxi build",
|
"build": "pnpm run initdata && vinxi build",
|
||||||
"start": "vinxi start",
|
"start": "vinxi start",
|
||||||
"initdata": "node ./src/initdata.js"
|
"initdata": "node ./src/initdata.js"
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 664 B After Width: | Height: | Size: 34 KiB |
Loading…
Add table
Reference in a new issue