Skip to content

Commit 1bd7101

Browse files
committed
update
1 parent 7b9e082 commit 1bd7101

File tree

1 file changed

+47
-102
lines changed

1 file changed

+47
-102
lines changed

README.md

Lines changed: 47 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,136 +1,82 @@
1-
# Brave Chat
1+
# Code Inbox
22

3-
[![Demo on Cloudflare](https://badgen.net/badge/icon/cloudflare/green?icon=telegram&label=brave-chat)](https://brave-chat.net/)
4-
[![Tag](https://badgen.net/github/tag/brave-chat/brave-chat)](https://github.com/brave-chat/brave-chat/releases/tag/v0.4.0)
5-
[![Docs](https://badgen.net/badge/icon/docs?icon=wiki&label)](https://docs.brave-chat.wiseai.dev)
6-
[![All Contributors](https://img.shields.io/badge/all_contributors-3-blue.svg?style=flat)](#contributors-)
3+
[![Demo on Cloudflare](https://badgen.net/badge/icon/cloudflare/green?icon=telegram&label=code-inbox)](https://code-inbox.com/)
4+
[![Tag](https://badgen.net/github/tag/wiseaidev/code-inbox)](https://github.com/wiseaidev/code-inbox/releases/tag/v0.1.0)
75

8-
![Brave Chat](./docs/static/images/banner.PNG "Brave Chat")
6+
![Code Inbox](./static/banner.png "Code Inbox")
97

10-
Brave Chat is a fully featured chat application developed to bring the power back to people. It's designed to be the ultimate open source slack alternative with privacy in mind. It is user-friendly with a clean interface that is easy to navigate.
8+
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.
119

12-
As well as being feature-rich, Brave Chat is also fully responsive, meaning it will work seamlessly on a wide range of devices. So whether you're chatting on your desktop or your mobile, you'll always have a great experience.
10+
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.
1311

14-
## Supported Features
15-
16-
- Forms validations.
17-
18-
![Email validation.](./docs/static/images/input-validation.png)
19-
20-
![Email validation.](./docs/static/images/password-validation.png)
21-
22-
- Keyboard shortcuts.
23-
24-
![Keyboard shortcuts.](./docs/static/images/keyboard-shortcuts.png)
25-
26-
- Sending and receiving text messages in real time.
27-
28-
![Sending and receiving text messages.](./docs/static/images/snd-rcv-text.gif)
29-
30-
- Sending and receiving images in real time.
31-
32-
![Sending and receiving images.](./docs/static/images/snd-rcv-img.gif)
33-
34-
- Instant notifications when submitting a form.
35-
36-
![Joining a room notification.](./docs/static/images/join-room-notification.png)
37-
38-
![add contact notification.](./docs/static/images/add-contact-notification.png)
39-
40-
- Adding and removing a contact using an email address of a registered user.
41-
42-
![Add contact form.](./docs/static/images/add-contact-form.png)
43-
44-
- Display chat list with unread messages count as a badge and timestamps.
45-
46-
![Custom badges, unread messages count, and timestamps.](./docs/static/images/custom-badges.png)
12+
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.
4713

48-
- Joining and creating rooms given a room name and or description.
49-
50-
![Create room form.](./docs/static/images/create-room.png)
51-
52-
- The ability to click on an avatar in a room to reveal detailed information about a given user.
53-
54-
![Room User Details.](./docs/static/images/room-user-details.png)
55-
56-
- Emojies support.
57-
58-
![Emojies support.](./docs/static/images/emojies.png)
59-
60-
- The ability to leave a room, and delete sent messages.
61-
62-
![Delete messages.](./docs/static/images/delete-messages.png)
14+
## Supported Features
6315

64-
![Deleted messages.](./docs/static/images/deleted-messages.png)
16+
Code Inbox currently offers a range of essential features to enhance your email management experience, including:
6517

66-
- The ability to render HTML tags, links, emails.
18+
1. **Intuitive User Interface:** A user-friendly interface designed for ease of use, ensuring effortless navigation and efficient email management.
6719

68-
![HTML tags being rendered.](./docs/static/images/bold-italic.png)
20+
1. **Algorithmic Recommendations:** Receive algorithmic learning posts generated by AI, delivered directly to your inbox, simplifying your learning journey.
6921

70-
- The ability to render Markdown text.
22+
## 2023 Roadmap
7123

72-
![HTML tags being rendered.](./docs/static/images/render-markdown.png)
24+
We are committed to continually improving Code Inbox to meet your evolving needs. Here are some exciting features we have planned for 2023:
7325

74-
- The ability to ban and unban room members.
26+
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.
7527

76-
![HTML tags being rendered.](./docs/static/images/moderation.gif)
28+
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.
7729

78-
## 2023 Roadmap
30+
1. **Label Coloring:** Customize your email labels with color coding, allowing you to visually organize and prioritize your messages more effectively.
7931

80-
- Enrypt and decrypt text messages on the client side using the signal protocol.
81-
- Add support for voice, videos, files messages.
82-
- Add support for voice and video calls.
32+
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.
8333

84-
## Components
34+
> **Note**<br>
35+
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.
8536

86-
Brave Chat code base is written to be developer-friendly, with code that is both standards-compliant and optimised for performance. It contains a handful list of reusable components. You can take a look at various components in [this section](https://chat-docs.wiseai.dev/folder-structure) of the docs, or expand the following collapsed section.
37+
## Reusable Components
8738

88-
### Running locally with NPM
39+
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.
8940

90-
> **Note**<br>
91-
Make sure you have [`pnpm`](https://pnpm.io/installation) installed on your machine.
41+
### Getting Started Locally with PNPM
9242

93-
1. Fork/Clone the repo:
43+
> **Please Note:**<br>
44+
Ensure that you have [`pnpm`](https://pnpm.io/installation) installed on your local machine before proceeding.
9445

95-
```sh
96-
git clone [email protected]:brave-chat/brave-chat.git
97-
```
46+
1. **Fork/Clone the Repository:**
9847

99-
1. Open the newly created directory:
48+
```sh
49+
git clone [email protected]:your_user_name/code-inbox.git
50+
```
10051

101-
```sh
102-
cd brave-chat
103-
pnpm install
104-
```
52+
1. **Navigate to the Project Directory:**
10553

106-
> **Warning**<br>
107-
In order to run the project locally or build for production use, you will need to set the following environment variables to connect with the server.
54+
```sh
55+
cd code-inbox
56+
```
10857

109-
```sh
110-
REACT_APP_SERVER_URL=http://localhost:8000/api/v1
111-
REACT_APP_SOCKET_URL=ws://localhost:8000/api/v1/ws
112-
```
58+
1. **Install Dependencies:**
11359

114-
1. Now, you can run the client:
60+
```sh
61+
pnpm install
62+
```
11563

116-
```sh
117-
pnpm run dev
118-
```
64+
1. **Run the Client:**
11965

120-
1. Navigate to [http://localhost:3000](http://localhost:3000) to explore the landing page.
66+
```sh
67+
pnpm run dev
68+
```
12169

122-
## Running locally with Compose v2
70+
1. **Explore the Landing Page:**
12371

124-
Navigate to [the server repository](https://github.com/brave-chat/brave-chat-server) and follow the instructions listed in [this section](https://github.com/brave-chat/brave-chat-server#running-locally-with-compose-v2) to run both the client and the server in docker containers.
72+
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.
12573

12674
## Deployment
12775

128-
> **Warning**<br>
129-
To deploy the client, you will need to set the following environment variables that help the client connect to the server.
130-
76+
> **Note**<br>
77+
To deploy the client, you will need to set the following environment variable that help the client connect to the server.
13178
```sh
132-
* REACT_APP_SERVER_URL - Your deployed server APIs url.
133-
* REACT_APP_SOCKET_URL - Your deployed server Sockets url.
79+
* VITE_SERVER_URL - Your deployed server APIs url.
13480
```
13581

13682
### **Deploy to a Static Hosting Provider**
@@ -158,8 +104,7 @@ To deploy the client, you will need to set the following environment variables t
158104
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:
159105

160106
```sh
161-
export REACT_APP_SERVER_URL=Your_deployed_server_APIs_url
162-
export REACT_APP_SOCKET_URL=Your_deployed_server_Sockets_url
107+
export VITE_SERVER_URL=Your_deployed_server_APIs_url
163108
```
164109

165110
1. Run Your Build Command:
@@ -180,4 +125,4 @@ To deploy the client, you will need to set the following environment variables t
180125

181126
### **Netlify**
182127

183-
[![Deploy on Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/brave-chat/brave-chat)
128+
[![Deploy on Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/wiseaidev/code-inbox)

0 commit comments

Comments
 (0)