https://github.com/chatyx/frontend

UI from chatyx project
https://github.com/chatyx/frontend

Last synced: about 2 months ago
JSON representation

UI from chatyx project

• Host: GitHub
• URL: https://github.com/chatyx/frontend
• Owner: Chatyx
• Created: 2022-11-05T16:12:14.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-29T19:48:33.000Z (almost 2 years ago)
• Last Synced: 2024-02-05T03:10:42.573Z (11 months ago)
• Language: TypeScript
• Size: 443 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Chatyx-frontend

![total-lines](https://img.shields.io/tokei/lines/github/Chatyx/frontend)

## Table of contents:

- [Architecture](#Architecture)

- [Quick start](#quick_start)

- [Configuration](#Configuration)

- [Additional](#Additional)

  - [Generate code from protobuf](#generate_protobuf)

## Architecture

### Feature-Sliced Design

The main idea consists of unidirectional data stream.

Downstream components can't use upstream ones.



##   Quick start

### Using single docker container

TODO

### Manually build from source code

First you should clone this repository:

```bash

$ git clone https://github.com/Chatyx/frontend.git

# or

$ git clone [email protected]:Chatyx/frontend.git

```

Next step is installing dependencies:

```bash

$ cd frontend

$ npm install

```

***Create .env configuration file from next chapter!***

And finally you can use:

```bash

# for run project on dev server:

$ npm run start

# for development build:

$ npm run dev

# for production build:

$ npm run build

```

## Configuration

For run project you also need to create  configuration file with name **.env**

It must be placed in the root directory (*near with the package.json*)

#### Basic view of file:

```dotenv

SERVER_URL=http://localhost:8000

WS_URL=ws://localhost:8080

CHAT_MESSAGES_STEP=20

APP_PORT=3000

```

## Additional

####  Generate code from protobuf:

If you want to regenerate code from protobuf, you can run this

```bash

protoc --plugin="./node_modules/.bin/protoc-gen-ts_proto" --ts_proto_opt=esModuleInterop=true --ts_proto_out="./src/entities/message" src/entities/message/consts/message.proto

```

But it is not necessary... The generated code is already in the repository