Skip to content
This repository was archived by the owner on Jun 15, 2025. It is now read-only.

Commit eba1b9c

Browse files
authored
Update README.md
1 parent 47cf955 commit eba1b9c

File tree

1 file changed

+2
-92
lines changed

1 file changed

+2
-92
lines changed

README.md

Lines changed: 2 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,2 @@
1-
2-
# Create Socket App <a href="https://socketsupply.co/guides/"><img src="https://img.shields.io/badge/Socket%20Runtime-Website-black?style=flat-square"></a>
3-
4-
`Create Socket App` is similar to React's `Create React App`.
5-
It will help you build native apps for mobile and desktop with Svelte, Reactjs, Vuejs and others!
6-
The idea is to provide a few basic boilerplates and some strong opinions so you can get coding on a production quality app as quickly as possible.
7-
8-
## Set up your Socket environement
9-
10-
You can find more details about prerequisites, instructions, and many useful tips in [Socket Runtime](https://socketsupply.co/guides/) documentation.
11-
12-
## Quick Overview
13-
14-
```bash
15-
$npx create-socket-app -h
16-
17-
usage: create-socket-app [react | react-ts | svelte | tonic | vanilla | vue]
18-
19-
```
20-
```
21-
$npx create-socket-app
22-
23-
Creating socket files...OK
24-
Initializing npm package...OK
25-
Installing dependencies...OK
26-
Adding package scripts...OK
27-
Updating project configuration...OK
28-
Copying project boilerplate...OK
29-
30-
Type 'npm start' to launch the app
31-
32-
```
33-
34-
## Getting Started
35-
36-
Creat an empty directory and that's it, you are ready to go!
37-
38-
You may choose one of the following methods:
39-
40-
### **npm**
41-
42-
Any of these following commands will work
43-
```bash
44-
npm init socket-app [react | react-ts | svelte | tonic | vanilla | vue]
45-
npm create socket-app [react | react-ts | svelte | tonic | vanilla | vue]
46-
47-
```
48-
49-
### **yarn**
50-
```bash
51-
yarn create socket-app [react | react-ts | svelte | tonic | vanilla | vue]
52-
```
53-
54-
### **pnpm**
55-
```bash
56-
pnpm create socket-app [react | react-ts | svelte | tonic | vanilla | vue]
57-
```
58-
59-
## Quick Demonstration Video
60-
61-
62-
63-
64-
https://github.com/socketsupply/create-socket-app/assets/79177582/eddfd2f3-bf8f-4727-87a6-5937deb28823
65-
66-
67-
68-
69-
## Output:
70-
71-
Now inside of your directory, you should have a `directory structure` like this:
72-
73-
```bash
74-
.
75-
├── README.md
76-
├── build.js
77-
├── package.json
78-
├── socket.ini
79-
├── src
80-
│   ├── icon.png
81-
│   ├── index.css
82-
│   ├── index.html
83-
│   └── index.js
84-
└── test
85-
├── index.js
86-
└── test-context.js
87-
```
88-
89-
## Contributing
90-
91-
If something doesn't work, please [Create an issue](https://github.com/socketsupply/create-socket-app).
92-
If you have questions or need help, please join our [Discord](https://discord.com/invite/YPV32gKCsH).
1+
> [!NOTE]
2+
> This tool has been deprecated.

0 commit comments

Comments
 (0)