diff --git a/README.md b/README.md index 7decdb7..77d9dc2 100644 --- a/README.md +++ b/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 + +[![Deploy with Vercel](https://vercel.com/button)](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. diff --git a/backend/README.md b/backend/README.md index e69de29..ae3fc4d 100644 --- a/backend/README.md +++ b/backend/README.md @@ -0,0 +1,28 @@ +# Anix Backend + +This is the backend for AniX, an unofficial WEB client for the Android app Anixart. + +It is using FastAPI and server as a proxy between app API and Web Client. + +## Deployment + +### Environment variables + +- API_PREFIX - sets the api prefix + +### Docker + + [Refer the docker deployment from root README file](../README.md#docker-deployment) + +## Vercel + +1. fork the repository +2. create a new project on vercel and set the root directory to backend +3. (optionally) set API_PREFIX env variable +4. click deploy + +### One-Click Deploy + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/Radiquum/AniX/tree/main/backend) + +*note*: this will create a new repository diff --git a/frontend/README.md b/frontend/README.md deleted file mode 100644 index 8a7fbc0..0000000 --- a/frontend/README.md +++ /dev/null @@ -1,10 +0,0 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!