Merge pull request #1 from wiseaidev/apis-fix

Apis fix

Author: wiseaidev

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+`support` room in the platform.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# 🌍 Contributing.
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+## 👶 Getting Started!
+
+Ready to contribute? Here's how to set up `code-inbox` for local development.
+
+1. Fork the `code-inbox` repo on GitHub.
+2. Clone your fork locally:
+
+```sh
+git clone [email protected]:your_name_here/code-inbox.git
+```
+
+3. Navigate to the recently created directory:
+
+```sh
+cd code-inbox
+```
+
+4. Install the main dependencies:
+
+```sh
+pnpm install
+```
+
+5. Create a branch for local development:
+
+```sh
+git checkout -b name-of-your-bugfix-or-feature
+```
+
+6. Set the following env variables:
+
+```sh
+export VITE_SERVER_URL=http://localhost:8000/api/v1
+```
+
+Now you can make your changes locally.
+
+7. Commit your changes and push your branch to GitHub:
+
+```sh
+git add .
+git commit -m "Your detailed description of your changes."
+git push origin name-of-your-bugfix-or-feature
+```
+
+8. Submit a pull request through the GitHub website.
+
+
+## 📙 Pull Request Guidelines.
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests, if applicable.
+
+Thank you for helping us improve!

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Mahmoud
+Copyright (c) 2023 Mahmoud Harmouch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,128 @@
-# React + Vite
+# Code Inbox
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+[![Demo on Cloudflare](https://badgen.net/badge/icon/cloudflare/green?icon=telegram&label=code-inbox)](https://code-inbox.com/)
+[![Tag](https://badgen.net/github/tag/wiseaidev/code-inbox)](https://github.com/wiseaidev/code-inbox/releases/tag/v0.1.0)
 
-Currently, two official plugins are available:
+![Code Inbox](./static/banner.png "Code Inbox")
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+Code Inbox is a sophisticated email client meticulously designed to streamline the process of mastering algorithms, offering AI-generated algorithmic posts delivered directly to your inbox. This robust platform is not only user-friendly but also offers an elegant and intuitive interface, ensuring effortless email management.
+
+With a wide array of features, Code Inbox empowers users to efficiently organize their email correspondence, making it a versatile tool for both beginners and experts alike. Its user-centric design simplifies navigation, allowing you to effortlessly manage your inbox, prioritize important messages, and optimize your algorithmic learning journey.
+
+Moreover, Code Inbox's adaptability shines through its fully responsive design, ensuring a seamless experience across various devices. Whether you're working on a desktop computer or accessing your emails on the go via a mobile device, you can count on Code Inbox to provide a consistently exceptional experience.
+
+## Supported Features
+
+Code Inbox currently offers a range of essential features to enhance your email management experience, including:
+
+1. **Intuitive User Interface:** A user-friendly interface designed for ease of use, ensuring effortless navigation and efficient email management.
+
+1. **Algorithmic Recommendations:** Receive algorithmic learning posts generated by AI, delivered directly to your inbox, simplifying your learning journey.
+
+## 2023 Roadmap
+
+We are committed to continually improving Code Inbox to meet your evolving needs. Here are some exciting features we have planned for 2023:
+
+1. **Unified Email Threads:** Enhance your email viewing experience by displaying entire email threads in a single page. This feature simplifies the way you follow conversations and ensures you have the context you need.
+
+1. **Attachment Support:** We will introduce the ability to send attachments with your emails, making it easier to share documents, files, and important resources with your contacts.
+
+1. **Label Coloring:** Customize your email labels with color coding, allowing you to visually organize and prioritize your messages more effectively.
+
+1. **Contact Management:** Streamline your email contacts by adding and deleting contacts directly from within Code Inbox. This feature simplifies your address book management and keeps it up to date.
+
+> **Note**<br>
+We are dedicated to delivering these enhancements to make Code Inbox even more powerful and tailored to your requirements in 2023. Stay tuned for these updates and more as we continue to evolve and improve our email client.
+
+## Reusable Components
+
+Code Inbox is committed to providing developers with a developer-friendly code base, featuring standards-compliant and performance-optimized code. Our codebase includes a curated collection of reusable components, designed to streamline the development process and promote code efficiency.
+
+### Getting Started Locally with PNPM
+
+> **Please Note:**<br>
+Ensure that you have [`pnpm`](https://pnpm.io/installation) installed on your local machine before proceeding.
+
+1. **Fork/Clone the Repository:**
+
+    ```sh
+    git clone [email protected]:your_user_name/code-inbox.git
+    ```
+
+1. **Navigate to the Project Directory:**
+
+    ```sh
+    cd code-inbox
+    ```
+
+1. **Install Dependencies:**
+
+    ```sh
+    pnpm install
+    ```
+
+1. **Run the Client:**
+
+    ```sh
+    pnpm run dev
+    ```
+
+1. **Explore the Landing Page:**
+
+    Open your web browser and go to [http://localhost:3000](http://localhost:3000) to explore the Code Inbox landing page and start interacting with the provided pages.
+
+## Deployment
+
+> **Note**<br>
+To deploy the client, you will need to set the following environment variable that help the client connect to the server.
+```sh
+* VITE_SERVER_URL - Your deployed server APIs url.
+```
+
+### **Deploy to a Static Hosting Provider**
+
+### **CloudFlare**
+
+1. Install [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/get-started/):
+
+   To get started with Cloudflare Workers, you'll need to install the Wrangler CLI, which is a powerful tool for managing your deployments. Open up your command-line interface and enter the following command to globally install Wrangler:
+
+   ```sh
+   npm install -g wrangler
+   ```
+
+1. Login to Cloudflare Account from the CLI:
+
+   To seamlessly interact with your Cloudflare account, you'll need to log in using Wrangler. Run the following command in your terminal:
+
+   ```sh
+   wrangler login
+   ```
+
+1. Configure Environment Variables for Client-Server Connection:
+
+   For your React app to communicate effectively with the server, you need to set a couple of environment variables. Replace the placeholders with actual URLs:
+
+   ```sh
+   export VITE_SERVER_URL=Your_deployed_server_APIs_url
+   ```
+
+1. Run Your Build Command:
+
+   Before deployment, ensure your project is finely tuned. Execute your build command to prepare your app for the world:
+
+   ```sh
+   pnpm run build
+   ```
+
+1. Create a New Deployment:
+
+   The moment has come to launch your creation into the online realm! Execute the following command to deploy your app with Wrangler Pages:
+
+   ```sh
+   wrangler pages deploy dist
+   ```
+
+### **Netlify**
+
+[![Deploy on Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/wiseaidev/code-inbox)

SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+The versions of the project that are currently supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.1.x   | :white_check_mark: |
+| < 1.0   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+You can report a vulnerability through our support `email`.

package.json

@@ -4,10 +4,10 @@
   "version": "0.0.1",
   "type": "module",
   "scripts": {
-    "dev": "vite --host 127.0.0.1 --port 3000",
+    "dev": "vite --port 3000 --host localhost",
     "build": "vite build",
     "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
-    "preview": "vite preview"
+    "preview": "vite preview --port 3000 --host localhost"
   },
   "dependencies": {
     "@emotion/react": "^11.11.1",