Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shaoyanji/solid-quickstart
https://github.com/shaoyanji/solid-quickstart
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/shaoyanji/solid-quickstart
- Owner: shaoyanji
- Created: 2024-03-20T01:08:17.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-20T01:40:46.000Z (10 months ago)
- Last Synced: 2024-03-20T02:37:38.873Z (10 months ago)
- Language: TypeScript
- Homepage: https://iso-solidstart.netlify.app
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SolidStart
A Solid Quickstart template that will get you started with everything you need to build a Solid project, powered by [`solid-start`](https://github.com/ryansolid/solid-start/tree/master/packages/solid-start);
Click the below button to quickly create a new repo, create a new Netlify project, and deploy!
[](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/solid-quickstart?utm_campaign=template-team&utm_source=dtn-button&utm_medium=dtn-button&utm_term=solid-qt-dtn-button&utm_content=solid-qt-dtn-button)
## Table of Contents
- [Project Structure](#project-structure)
- [Getting Started](#getting-started)
- [Building](#building)
- [Deploying using the Netlify CLI](#deploying-using-the-netlify-cli)
## Project Structure
Inside of your Solidjs project, you'll see the following folders and files:
```
/
├── public/
│ └── favicon.ico
├── src/
│ ├── components/
│ │ └── Counter.css
│ │ └── Counter.tsx
│ └── routes/
│ └── [...404].tsx
│ └── index.tsx
├── entry-client.tsx
├── entry-server.tsx
├── root.css
├── root.tsx
├── package.json
└── vite.config.json
```
## Getting Started
If you want to get started locally, you can clone the project, install the dependencies and run the dev command!
```
git clone https://github.com/netlify-templates/solid-quickstart.git
cd solid-quickstart
npm install
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 `npm start`. To use a different adapter, add it to the `devDependencies` in `package.json` and specify in your `vite.config.js`.
## Deploying using the Netlify CLI
- Install the Netlify CLI globally `npm install netlify-cli -g`
- Run `npm run build`
- Then use the `netlify deploy` for a deploy preview link or `netlify deploy --prod` to deploy to production
Here are a few other ways you can deploy this template:
- Use the Netlify CLI's create from template command `netlify sites:create-template solid-quickstart` which will create a repo, Netlify project, and deploy it
- If you want to utilize continuous deployment through GitHub webhooks, run the Netlify command `netlify init` to create a new project based on your repo or `netlify link` to connect your repo to an existing project
Hope this template helps :) Happy coding 👩🏻💻!