Code Inbox

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.

2. 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.

2. 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.

3. Label Coloring: Customize your email labels with color coding, allowing you to visually organize and prioritize your messages more effectively.

4. 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
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

Note
Ensure that you have pnpm installed on your local machine before proceeding.

1. Fork/Clone the Repository:

   git clone [email protected]:your_user_name/code-inbox.git

2. Navigate to the Project Directory:

   cd code-inbox

3. Install Dependencies:

   pnpm install

4. Run the Client:

   pnpm run dev

5. Explore the Landing Page:

   Open your web browser and go to http://localhost:3000 to explore the Code Inbox landing page and start interacting with the provided pages.

Deployment

Note
To deploy the client, you will need to set the following environment variable that help the client connect to the server.

* VITE_SERVER_URL - Your deployed server APIs url.

Deploy locally with Compose v2

Navigate to the server repository and follow the instructions listed in the readme file to run both the client and the server in docker containers.

Deploy to a Static Hosting Provider

CloudFlare

1. Install Wrangler CLI:

   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:

   npm install -g wrangler

2. 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:

   wrangler login

3. 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:

   export VITE_SERVER_URL=Your_deployed_server_APIs_url

4. Run Your Build Command:

   Before deployment, ensure your project is finely tuned. Execute your build command to prepare your app for the world:

   pnpm run build

5. 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:

   wrangler pages deploy dist

Netlify