chore: improved readme
This commit is contained in:
parent
85ef557149
commit
29f4219d95
3 changed files with 22 additions and 25 deletions
4
.env.example
Normal file
4
.env.example
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
VITE_API_ID=
|
||||||
|
VITE_API_HASH=
|
||||||
|
VITE_IFRAME_URL=http://localhost:3001
|
||||||
|
VITE_HOST_ORIGIN=http://localhost:3000
|
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -12,6 +12,10 @@ dist
|
||||||
dist-ssr
|
dist-ssr
|
||||||
*.local
|
*.local
|
||||||
|
|
||||||
|
.env
|
||||||
|
.env.*
|
||||||
|
!.env.example
|
||||||
|
|
||||||
# Editor directories and files
|
# Editor directories and files
|
||||||
.vscode/*
|
.vscode/*
|
||||||
!.vscode/extensions.json
|
!.vscode/extensions.json
|
||||||
|
|
39
README.md
39
README.md
|
@ -1,28 +1,17 @@
|
||||||
## Usage
|
# mtcute repl
|
||||||
|
|
||||||
|
## setting up
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ npm install # or pnpm install or yarn install
|
pnpm i
|
||||||
|
|
||||||
|
cd vendor
|
||||||
|
bash build-patched-chobitsu.sh
|
||||||
|
cd ..
|
||||||
|
|
||||||
|
cp .env.example .env
|
||||||
|
# fill the values
|
||||||
|
|
||||||
|
pnpm dev
|
||||||
|
# then open http://localhost:3000
|
||||||
```
|
```
|
||||||
|
|
||||||
### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
|
|
||||||
|
|
||||||
## Available Scripts
|
|
||||||
|
|
||||||
In the project directory, you can run:
|
|
||||||
|
|
||||||
### `npm run dev`
|
|
||||||
|
|
||||||
Runs the app in the development mode.<br>
|
|
||||||
Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
|
|
||||||
|
|
||||||
### `npm run build`
|
|
||||||
|
|
||||||
Builds the app for production to the `dist` folder.<br>
|
|
||||||
It correctly bundles Solid in production mode and optimizes the build for the best performance.
|
|
||||||
|
|
||||||
The build is minified and the filenames include the hashes.<br>
|
|
||||||
Your app is ready to be deployed!
|
|
||||||
|
|
||||||
## Deployment
|
|
||||||
|
|
||||||
Learn more about deploying your application with the [documentations](https://vitejs.dev/guide/static-deploy.html)
|
|
||||||
|
|
Loading…
Reference in a new issue