Skip to content

Rudra-Sankha-Sinhamahapatra/Texon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Texon

A Chatting Site

Tech Stacks

Backend

  • Framework: Node JS
  • Real-time Communication: Socket.IO
  • Caching: Redis for pub-sub queries
  • Language: Typescript

Frontend

  • Framework: Turborepo, Next.js, React.js
  • Styling: Tailwind CSS
  • Language: Typescript

Description

Texon is a real-time chatting platform built with Node.js and Socket.IO for seamless communication between users. Redis is utilized for pub-sub queries, ensuring efficient message broadcasting and handling. The frontend leverages Turborepo for modular development, Next.js for server-side rendering, React.js for interactive UI components, and Tailwind CSS for responsive styling.

This project aims to provide users with a dynamic and responsive chatting experience, combining robust backend technologies with a modern and efficient frontend architecture.

Getting Started

To run this project locally, follow these steps:

  1. Clone this repository or download the root folder.

    git clone https://github.com/Rudra-Sankha-Sinhamahapatra/Texon
  2. Install dependencies for all.

    yarn install
  3. Install dependencies for the backend.

    cd apps/server
    yarn install
  4. Install dependencies for the frontend.

    cd ../web
    yarn install
  5. Create a .env file in the root of the server folder and store your Redis information as per .env.example

    touch ../server/.env
  6. Come Back to the root folder and start your turborpo project locally

    cd ../../
    yarn dev

License

This project is licensed under the MIT License - see the MIT file for details.


It includes instructions for building the frontend and deploying to Cloudflare, enhancing the clarity and completeness of the setup and deployment process for your project. Adjust paths and commands as necessary based on your specific project structure and deployment requirements.

# Turborepo starter

This is an official starter Turborepo.

## Using this example

Run the following command:

```sh
npx create-turbo@latest

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

  • docs: a Next.js app
  • web: another Next.js app
  • @repo/ui: a stub React component library shared by both web and docs applications
  • @repo/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • @repo/typescript-config: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This Turborepo has some additional tools already setup for you:

Build

To build all apps and packages, run the following command:

cd my-turborepo
pnpm build

Develop

To develop all apps and packages, run the following command:

cd my-turborepo
pnpm dev

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd my-turborepo
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

npx turbo link

Useful Links

Learn more about the power of Turborepo: