mirror of
https://github.com/Radiquum/AniX.git
synced 2025-04-30 01:49:40 +05:00
docs(readme/deploy): add a vercel deploy instructions
This commit is contained in:
parent
c0d295c78a
commit
3b222e0cc5
3 changed files with 55 additions and 10 deletions
27
README.md
27
README.md
|
@ -2,6 +2,10 @@
|
|||
|
||||
AniX is an unofficial web client for the Android application Anixart. It allows you to access and manage your Anixart account from a web browser on your desktop or laptop computer.
|
||||
|
||||
[Changelog](./CHANGELOG.md)
|
||||
|
||||
[Backend Readme](./backend/README.md)
|
||||
|
||||
## Screenshots
|
||||
|
||||
**User profile page**
|
||||
|
@ -89,6 +93,8 @@ To access the docker logs you can use `docker compose -f docker-compose.dev.yml
|
|||
|
||||
## Deployment
|
||||
|
||||
### first steps
|
||||
|
||||
1. clone this repository via `git clone https://github.com/Radiquum/AniX.git`
|
||||
2. cd into the repository folder.
|
||||
3. deploy app with below instructions.
|
||||
|
@ -152,6 +158,27 @@ To access the docker logs you can use `docker compose -f docker-compose.dev.yml
|
|||
|
||||
You can find more details in the Deta Space documentation: [Deta Space Docs](https://docs.deta.space/)
|
||||
|
||||
### Vercel
|
||||
|
||||
*note* you don't need to complete the first steps for vercel deploy
|
||||
|
||||
1. [Deploy the backend](./backend/README.md#vercel) and copy the production url, including the prefix
|
||||
2. create a new project on vercel and set the root directory to frontend
|
||||
3. set API_URL env variable to copied url
|
||||
4. click deploy
|
||||
|
||||
#### Available environment variables
|
||||
|
||||
- API_URL - sets the api url to use for frontend to connect to the backend
|
||||
|
||||
#### One-Click Deploy
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https://github.com/Radiquum/AniX/tree/main/frontend)
|
||||
|
||||
*note*: this will create a new repository.
|
||||
|
||||
*note*: don't forget to set API_URL to backend url.
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions to this project! If you have any bug fixes, improvements, or new features, please feel free to create a pull request.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue