ajax/SFIS
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新 README.md

Browse Source
This commit is contained in:
Wang Zhiyu 2023-06-08 00:52:26 +08:00 committed by GitHub
parent 3c82db9fa2
commit c548ab747b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
server/README.md
View File

@ -1,23 +1,16 @@
# Welcome # Welcome
SFIS -- A simple cross-platform Static File Index System SFIS -- A simple cross-platform Static File Indexing Software
[Website](https://sfis.wangzhiyu.ga/) [Website](https://sfis.ga/)
[Preview](https://sfis-eg.vercel.app) [Preview](https://sample.sfis.ga)
## Quick Start ## Quick Start
1. Install Python 3.x from python.org 1. Install Python 3.x from python.org or pkg manager
2. Install Package from Internet 2. Install Python Packages from Internet
``` bash ``` bash
python3 -m pip install Markdown pyyaml fire python3 -m pip install Markdown pyyaml fire
``` ```
If it doesn't work, try: 3. Clone Source Code
``` bash Git should be installed first.
python -m pip install Markdown pyyaml fire Run the command in shell (bash or cmd)
```
3. Clone Code
GUI Way:
Click "Code" button, download the ZIP package and extract it to run it.
CLI Way:
You should install git or gitbash first.
Run the command in terminal(bash or cmd)
``` bash ``` bash
git clone https://github.com/david-ajax/sfis/ && cd sfis git clone https://github.com/david-ajax/sfis/ && cd sfis
``` ```
@ -25,5 +18,8 @@ CLI Way:
``` bash ``` bash
python3 main.py python3 main.py
``` ```
Put your files in "files" folder. HTML files should be generated in the folder.
Upload project root folder to your static cloud storage space(such as GitHub or Vercel) and builds the index file, you can get a useful personal static cloud space now! Try to move the folder into a webserver.
Redeploy to update static web files after putting your files in "files" folder.
## Serverless Deploy
todo