Skip to content

Commit 8cb4d53

Browse files
taty2010maxcellMarcL
authored
Update Readme (#2)
* Update Readme * Update README.md Co-authored-by: Prince Wilson <maxcell.wilson@gmail.com> * removed routes * changed 'on' to 'with' Co-authored-by: Marc Littlemore <MarcL@users.noreply.github.com> * added banner Co-authored-by: Prince Wilson <maxcell.wilson@gmail.com> Co-authored-by: Marc Littlemore <MarcL@users.noreply.github.com>
1 parent 4cf12ce commit 8cb4d53

File tree

1 file changed

+56
-12
lines changed

1 file changed

+56
-12
lines changed

README.md

Lines changed: 56 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,53 @@
11
# SolidStart
22

3-
Everything you need to build a Solid project, powered by [`solid-start`](https://github.com/ryansolid/solid-start/tree/master/packages/solid-start);
3+
![solid (3)](https://user-images.githubusercontent.com/43764894/199539679-a1b9fbcb-3ec5-4fd7-b2d9-5cc25b248295.png)
44

5-
## Creating a project
65

7-
```bash
8-
# create a new project in the current directory
9-
npm init solid
106

11-
# create a new project in my-app
12-
npm init solid my-app
7+
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);
8+
9+
Click the below button to quickly create a new repo, create a new Netlify project, and deploy!
10+
11+
[![Deploy to Netlify Button](https://www.netlify.com/img/deploy/button.svg)](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)
12+
13+
## Table of Contents
14+
- [Project Structure](#project-structure)
15+
- [Getting Started](#getting-started)
16+
- [Building](#building)
17+
- [Deploying using the Netlify CLI](#deploying-using-the-netlify-cli)
18+
19+
## Project Structure
20+
21+
Inside of your Solidjs project, you'll see the following folders and files:
22+
23+
```
24+
/
25+
├── public/
26+
│ └── favicon.ico
27+
├── src/
28+
│ ├── components/
29+
│ │ └── Counter.css
30+
│ │ └── Counter.tsx
31+
│ └── routes/
32+
│ └── [...404].tsx
33+
│ └── index.tsx
34+
├── entry-client.tsx
35+
├── entry-server.tsx
36+
├── root.css
37+
├── root.tsx
38+
├── package.json
39+
└── vite.config.json
1340
```
1441

15-
## Developing
42+
## Getting Started
1643

17-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
44+
If you want to get started locally, you can clone the project, install the dependencies and run the dev command!
1845

19-
```bash
46+
```
47+
git clone https://github.com/netlify-templates/solid-quickstart.git
48+
cd solid-quickstart
49+
npm install
2050
npm run dev
21-
2251
# or start the server and open the app in a new browser tab
2352
npm run dev -- --open
2453
```
@@ -27,4 +56,19 @@ npm run dev -- --open
2756

2857
Solid apps are built with _adapters_, which optimise your project for deployment to different environments.
2958

30-
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`.
59+
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`.
60+
61+
## Deploying using the Netlify CLI
62+
- Install the Netlify CLI globally `npm install netlify-cli -g`
63+
64+
- Run `npm run build`
65+
66+
- Then use the `netlify deploy` for a deploy preview link or `netlify deploy --prod` to deploy to production
67+
68+
Here are a few other ways you can deploy this template:
69+
70+
- 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
71+
72+
- 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
73+
74+
Hope this template helps :) Happy coding 👩🏻‍💻!

0 commit comments

Comments
 (0)