add README

huangcheng · Dec 1, 2023 · 21d4de5 · 21d4de5
1 parent 972d765
commit 21d4de5
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "startpage-server"
 authors = ["HUANG Cheng <cheng@duck.com>"]
+repository = "https://github.com/huangcheng/startpage-server"
 version = "0.1.0"
 edition = "2021"
 

diff --git a/README.md b/README.md
@@ -0,0 +1,61 @@
+# StartPage
+**StartPage** is a start page for your browser.
+
+![Home](docs/homepage.png)
+
+
+## Features
+
+![Login](docs/login.png)
+
+### Categories
+
+Create and manage different categories to organize your websites efficiently.
+
+![Category](docs/category.png)
+
+![Categoris Management](docs/categories_management.png)
+
+### Sites
+Add, edit, and remove your favorite websites within each category.
+
+![Site](docs/site.png)
+
+### User Management
+Manage user's accounts.
+
+![User Management](docs/user.png)
+
+## Getting Started
+
+This is this the backend service of the project. You can find the frontend [here](https://github.com/huangcheng/startpage-web).
+
+### Installation
+1. Clone the repository:
+```bash
+git clone https://github.com/huangcheng/startpage-server 
+```
+2. Make sure you have the `sqlx-cli` installed with the `mysql` feature enabled:
+```bash
+cargo install sqlx-cli --no-default-features --features native-tls,mysql
+```
+
+3. Run the database migrations:
+```bash
+export DATABASE_URL=mysql://<username>:<password>@<host>:<port>/<database>
+sqlx migrate run
+```
+or 
+```bash
+sql migrate run --database-url mysql://<username>:<password>@<host>:<port>/<database>
+```
+
+4. Configure the server by copying the `Rocekt.toml.exmaple` file to `Rocket.toml` and editing it to your needs.
+
+5. Run the server:
+```bash
+cargo run
+```
+
+## License
+The designer of the project is [huqinxue](https://github.com/huqinxue)
diff --git a/docs/categories_management.png b/docs/categories_management.png
diff --git a/docs/category.png b/docs/category.png
diff --git a/docs/homepage.png b/docs/homepage.png
diff --git a/docs/login.png b/docs/login.png
diff --git a/docs/site.png b/docs/site.png
diff --git a/docs/user.png b/docs/user.png