Skip to content

Commit ccdf28d

Browse files
nikdelvinnikdelvin
committed
README.md Update
1 parent 5f743c4 commit ccdf28d

File tree

3 files changed

+536
-456
lines changed

3 files changed

+536
-456
lines changed

‎README.md‎

Lines changed: 163 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,184 @@
1-
# Starlight Starter Kit: Tailwind
1+
# 🤖 Neuroly
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3+
> Generate beautiful ideas with smart, personalized assistant fully trained for creative conversations
44
5+
AI chatbot based on 56B tokens LLM, powered by speech-to-text and voice synthesis.
6+
7+
[![Live Website](https://img.shields.io/badge/🌐_Live-neuroly.by.nikdelv.in-error)](https://neuroly.by.nikdelv.in)
8+
[![App](https://img.shields.io/badge/🚀_App-neuroly.app.nikdelv.in-primary)](https://neuroly.app.nikdelv.in)
9+
[![GitHub](https://img.shields.io/badge/GitHub-nikdelvin/neuroly-blue)](https://github.com/nikdelvin/neuroly)
10+
11+
## 🌟 Overview
12+
13+
Neuroly is an innovative AI chatbot platform that combines:
14+
15+
- 🎤 **Speech-to-text** recognition in 57 languages with professional fluency
16+
- 🗣️ **Voice synthesis** with 20+ unique multilingual AI voices
17+
- 🧠 **Large language model** based on 56B tokens for natural conversations
18+
- 🎭 **Personality customization** with adaptive tone and speaking styles
19+
20+
## ✨ Features
21+
22+
### Chatbot Who Listens - To Recognize
23+
24+
Ask all your exciting questions the way you want:
25+
26+
- **Professional Speech Recognition**: 56 billion tokens and 700,000 training hours AI model resulting in cutting-edge accuracy
27+
- **Contextual Understanding**: Goes beyond simple keywords, allowing for natural, engaging conversations and personalized interaction
28+
- **Multilingual Support**: Professional fluency in 57 diverse languages ranging from English to Mandarin Chinese
29+
- **Natural Conversations**: Understands context, emotions, and nuances for truly human-like interactions
30+
31+
### Chatbot Who Speaks - To Answer
32+
33+
Get answers in a way you can easily listen and understand:
34+
35+
- **Realistic AI Voices**: More than 20 unique multilingual AI voices trained with experienced voice actors to sound real
36+
- **Adaptive Tone**: Speaking style that adjusts to context, mirroring your emotions and energy levels
37+
- **Customizable Personas**: Define model persona's backstory to get more immersive conversations
38+
- **Emotional Intelligence**: Responds with appropriate sentiment and emotional awareness
39+
40+
## 🗺️ Project Roadmap
41+
42+
### Phase I: Multilingual Foundation (Current)
43+
44+
Core for speech recognition & NLP engine including:
45+
46+
- Diverse language dataset of speech and text in 57 languages with various accents, dialects, and speaking styles
47+
- Transformer-based architecture for speech recognition and NLP tasks capable of handling multilingual input
48+
- Evaluation metrics, hyperparameter tuning, and data augmentation for professional fluency across all languages
49+
50+
### Phase II: Personality Customization (Coming Soon)
51+
52+
Emotions, adaptive tone & speaking style:
53+
54+
- Sentiment analysis integration to detect and interpret emotions accurately in text or speech
55+
- Wide library of unique AI voices by experienced voice actors representing diverse backgrounds
56+
- Tool for defining and customizing AI personalities aligned with user preferences
57+
58+
### Phase III: Contextual Awareness
59+
60+
Topics perception & proactive suggestions:
61+
62+
- Coreference resolution for accurate entity tracking across multiple sentences
63+
- Algorithm to track topic evolution throughout conversations and adapt responses accordingly
64+
- Personalized content retrieval system for articles, recommendations, and data based on user interests
65+
66+
### Phase IV: Advanced Interaction
67+
68+
Seamless language & text format switching:
69+
70+
- Cross-lingual transfer learning for multilingual conversation understanding
71+
- Text normalization to handle variations in spelling, punctuation, and grammar
72+
- Dynamic format switching for seamless transitions between languages and communication styles
73+
74+
## 🛠️ Tech Stack
75+
76+
- **Framework**: [Astro](https://astro.build) - Modern static site generator
77+
- **Styling**: [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS framework
78+
- **UI Library**: [TailyUI](https://tailyui.by.nikdelv.in) - Pure Tailwind CSS UI components
79+
- **Language**: TypeScript - Type-safe JavaScript
80+
- **Deployment**: Firebase Hosting
81+
82+
## 🚀 Getting Started
83+
84+
### Prerequisites
85+
86+
- Node.js (latest LTS version recommended)
87+
- npm or yarn package manager
88+
89+
### Installation
90+
91+
```bash
92+
# Clone the repository
93+
git clone https://github.com/nikdelvin/neuroly.git
94+
cd neuroly
95+
96+
# Install dependencies
97+
npm install
598
```
6-
npm create astro@latest -- --template starlight/tailwind
99+
100+
### Development
101+
102+
```bash
103+
# Start development server with linting and formatting
104+
npm run start
105+
106+
# Or just run Astro dev server
107+
npm run dev
7108
```
8109

9-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
110+
The site will be available at `http://localhost:4321`
10111

11-
## 🚀 Project Structure
112+
### Build
12113

13-
Inside of your Astro + Starlight project, you'll see the following folders and files:
114+
```bash
115+
# Build for production (includes linting and type checking)
116+
npm run build
14117

118+
# Preview production build
119+
npm run preview
15120
```
16-
.
17-
├── public/
121+
122+
## 📁 Project Structure
123+
124+
```text
125+
neuroly/
126+
├── public/ # Static assets
127+
│ └── favicon.svg
18128
├── src/
19-
│ ├── assets/
20-
│ ├── content/
21-
│ │ └── docs/
22-
│ ├── styles/
129+
│ ├── assets/ # Images and media
130+
│ │ └── houston.webp
131+
│ ├── content/ # Content collections
132+
│ │ └── docs/ # Documentation files
133+
│ │ ├── index.mdx # Documentation home
134+
│ │ ├── knowledge/ # Bodies of knowledge
135+
│ │ └── p1-swebok/ # SWEBOK chapters
136+
│ ├── styles/ # Global styles
23137
│ │ └── global.css
24-
│ └── content.config.ts
25-
├── astro.config.mjs
26-
├── package.json
27-
└── tsconfig.json
138+
│ └── content.config.ts # Content collections config
139+
├── astro.config.mjs # Astro configuration
140+
├── firebase.json # Firebase hosting config
141+
├── tailwind.config.ts # Tailwind CSS configuration
142+
├── tsconfig.json # TypeScript configuration
143+
├── package.json # Dependencies and scripts
144+
├── LICENSE # Project license
145+
└── README.md # Project documentation
28146
```
29147

30-
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
148+
## 📜 Available Scripts
149+
150+
| Command | Description |
151+
| ------------------ | ------------------------------------------------------ |
152+
| `npm run start` | Formats, lints, and starts dev server |
153+
| `npm run build` | Formats, lints, type-checks, and builds for production |
154+
| `npm run preview` | Preview production build locally |
155+
| `npm run eslint` | Run ESLint on TypeScript and Astro files |
156+
| `npm run prettier` | Format all files with Prettier |
157+
158+
## 👨‍💻 Creator
159+
160+
Created by [Nikita Stadnik](https://nikdelv.in) - Passionate Fullstack Web Developer
161+
162+
- 📧 Email: [the@nikdelv.in](mailto:the@nikdelv.in)
163+
- 🐙 GitHub: [@nikdelvin](https://github.com/nikdelvin)
164+
- 💼 LinkedIn: [@nikdelvin](https://www.linkedin.com/in/nikdelvin)
31165

32-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
166+
## 🔗 Related Projects
33167

34-
Static assets, like favicons, can be placed in the `public/` directory.
168+
- [TailyUI](https://tailyui.app.nikdelv.in) - Modern UI Library built with pure Tailwind CSS
169+
- [Brodly](https://brodly.app.nikdelv.in) - High-secure anonymous live-streaming platform
170+
- [Scientry](https://scientry.app.nikdelv.in) - Data management & visualization tool
171+
- [Scripty](https://scripty.app.nikdelv.in) - Practice-oriented educational platform to learn JavaScript
172+
- [Feelicy](https://feelicy.app.nikdelv.in) - Self-improvement platform with meditation and habit tracking
35173

36-
The project includes [Tailwind CSS](https://starlight.astro.build/guides/css-and-tailwind/#tailwind-css) for styling. Customize your design by modifying `src/styles/global.css`.
174+
## 📄 License
37175

38-
## 🧞 Commands
176+
This project is licensed under the terms specified in the [LICENSE](./LICENSE) file.
39177

40-
All commands are run from the root of the project, from a terminal:
178+
## 🤝 Contributing
41179

42-
| Command | Action |
43-
| :------------------------ | :----------------------------------------------- |
44-
| `npm install` | Installs dependencies |
45-
| `npm run dev` | Starts local dev server at `localhost:4321` |
46-
| `npm run build` | Build your production site to `./dist/` |
47-
| `npm run preview` | Preview your build locally, before deploying |
48-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
49-
| `npm run astro -- --help` | Get help using the Astro CLI |
180+
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/nikdelvin/neuroly/issues).
50181

51-
## 👀 Want to learn more?
182+
---
52183

53-
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
184+
**Start your conversation today!** 🤖 Visit [neuroly.app.nikdelv.in](https://neuroly.app.nikdelv.in)

0 commit comments

Comments
 (0)