yinjiayi/space-web

The client functions as the system's frontend, granting us with access to all functionalities of the AO.space.

space-web

English | 简体中文

• space-web
  • Introduction
    • Architecture Design
    • Development Instructions
    • Deployment Instructions
  • Contribution Guidelines
  • Contact us
  • Thanks for your contribution

Introduction

The client functions as the system's frontend, granting us with access to all functionalities of the AO.space. It encompasses Web, iOS, Android platforms, providing the following key modules:

• End-to-End Encryption Channel
• Files
• Devices
• Space Application
• Developer Options
• Security

Architecture Design

space-web is developed using JavaScript and utilizes technologies such as Vue3, Element-plus, Axios, Jsencrypt, and service-worker. The business layer includes pages such as login, quick login, mine, and homepage, and uses web localization technology to ensure smooth file operations.

Development Instructions

1. Enter your working directory and run the command git clone https://github.com/ao-space/space-web.git.
2. Enter the space-web directory cd ./space-web.
3. Install dependencies by running npm install.
4. Run npm run dev for development.
5. This project is the web component of AO.space, and the server-side interface uses the space-gateway interface. When developing, please modify the target property in the vite-dev file in the root directory to point to the space-gateway interface address. See the following image for details.

Deployment Instructions

1. Determine the domain name exposed to the outside world for this project and the space-gateway interface domain name.
2. If the domain name exposed to the outside world for this project and the space-gateway interface domain name are inconsistent, modify the baseurl of urlConfig in src/config/networkConfig.ts to the space-gateway interface domain name. See the following image for details.
3. Run docker build -t space-web . in the project root directory.
4. Run the packaged nginx image by executing the command docker run -d --name space-web -p 80:80 space-web (Refer to the Docker documentation for specific Docker commands).

Contribution Guidelines

Contributions to this project are very welcome. Here are some guidelines and suggestions to help you get involved in the project.

Contribution Guidelines

Contact us

• Email: developer@ao.space
• Official Website
• Discussion group

Thanks for your contribution

Finally, thank you for your contribution to this project. We welcome contributions in all forms, including but not limited to code contributions, issue reports, feature requests, documentation writing, etc. We believe that with your help, this project will become more perfect and stronger.