Nucleus

Nucleus is a chat app build with Next.js and Nest.js. The name comes from the tv series Silicon Valley

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. License
5. Contact

About The Project

Nucleus is a little chat app i build. You can join and create rooms to chat with other people or friends.

Built With

• Next.js
• React.js
• Nest.js
• Socket.IO
• TailwindCss

Getting Started

Prerequisites

This project uses yarn as packet manager.

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/Louis3797/nucleus-chat-app.git

2. Install yarn packages

    yarn init

3. Start Next.js

   cd client
   yarn start

4. Start Nest

   cd..
   cd server
   nest start

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

• Adding Rooms
• Add jwt
• Sending Pictures
• Sending Yt Videos
• Log out button
• Upgrade ui and ux
• Bug fixing
• Add docker container

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Louis

Project Link: Nucleus