From 227bada36558bbf68446ae77a0d70fce1a9c7538 Mon Sep 17 00:00:00 2001
From: Kentai Radiquum <kentai.waah@gmail.com>
Date: Sun, 21 Apr 2024 01:31:01 +0500
Subject: [PATCH] ADD README files

---
 README.md          | 94 ++++++++++++++++++++++++++++++++++++++++++++++
 backend/README.md  |  0
 frontend/README.md | 26 -------------
 3 files changed, 94 insertions(+), 26 deletions(-)
 create mode 100644 README.md
 create mode 100644 backend/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..41dc588
--- /dev/null
+++ b/README.md
@@ -0,0 +1,94 @@
+# AniX - Unofficial Web Client for Anixart
+
+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.
+
+## Project Structure
+
+This project consists of two main parts:
+
+1. **Backend (Python with FastAPI):** This handles communication with the Anixart API and provides data to the frontend.
+2. **Frontend (Next.js):** This is the user interface that you interact with in your web browser. It fetches data from the backend and displays it in a user-friendly way.
+
+## Disclaimer
+
+Please note that AniX is an unofficial project and is not affiliated with the developers of Anixart. It is recommended to use the official Anixart app for the most up-to-date features and functionality.
+
+## Getting Started
+
+### Prerequisites
+
+* Python 3.6 or later ([https://www.python.org/downloads/](https://www.python.org/downloads/))
+* Node.js and npm ([https://nodejs.org/en](https://nodejs.org/en))
+
+### Setting Up the Backend
+
+1. Clone this repository.
+2. Navigate to the project directory in your terminal.
+3. Create a virtual environment to isolate project dependencies:
+
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # For Linux/macOS
+   venv\Scripts\activate.bat  # For Windows
+   ```
+
+4. Install the required backend dependencies:
+
+   ```bash
+   pip install -r ./requirements.txt
+   ```
+
+5. (Optional) Create a `.env` file in the project root directory to store sensitive information like API keys.
+
+### Setting Up the Frontend
+
+1. Navigate to the `frontend` directory.
+2. Install the required frontend dependencies:
+
+   ```bash
+   npm install
+   ```
+
+### Running the Project
+
+1. Start the backend server:
+
+   ```bash
+   cd ..  # Navigate back to the project root directory
+   uvicorn main:app --reload
+   ```
+
+2. Start the frontend development server:
+
+   ```bash
+   cd frontend
+   npm run dev
+   ```
+
+3. Start local reverse proxy server like traefik
+
+    ```to be added soon```
+
+This will start the development server for both the backend and frontend. You can access the AniX web client in your browser at ```no url for now```.
+
+<!-- ## Development
+
+The code for both the backend and frontend is well-commented and should be easy to understand and modify. Feel free to make changes and experiment with the project. -->
+
+## Deployment
+
+### Docker
+
+To be added soon . . .
+
+### Deta Space
+
+To be added soon . . .
+
+### Standalone
+
+To be added soon . . .
+
+## 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
new file mode 100644
index 0000000..e69de29
diff --git a/frontend/README.md b/frontend/README.md
index 0dc9ea2..8a7fbc0 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -1,25 +1,5 @@
 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).
 
-## Getting Started
-
-First, run the development server:
-
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.
-
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
 ## Learn More
 
 To learn more about Next.js, take a look at the following resources:
@@ -28,9 +8,3 @@ To learn more about Next.js, take a look at the following resources:
 - [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!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.