Skip to content

Commit d2bbc32

Browse files
nikdelvinnikdelvin
committed
README.md Update
1 parent 51a8bbc commit d2bbc32

File tree

3 files changed

+1372
-1157
lines changed

3 files changed

+1372
-1157
lines changed

‎README.md‎

Lines changed: 173 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,192 @@
1-
# Starlight Starter Kit: Basics
1+
# 🌳 Feelicy
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3+
> Create beautiful forest of thoughts, plans, and habits inside the best platform for self-improvement
44
5-
```
6-
npm create astro@latest -- --template starlight
5+
Meditation, focus, mind mapping, and goal planning in game format of Garden Simulator.
6+
7+
[![Live Website](https://img.shields.io/badge/🌐_Live-feelicy.by.nikdelv.in-success)](https://feelicy.by.nikdelv.in)
8+
[![App](https://img.shields.io/badge/🚀_App-feelicy.app.nikdelv.in-primary)](https://feelicy.app.nikdelv.in)
9+
[![GitHub](https://img.shields.io/badge/GitHub-nikdelvin/feelicy-blue)](https://github.com/nikdelvin/feelicy)
10+
11+
## 🌟 Overview
12+
13+
Feelicy is an innovative self-improvement platform that combines:
14+
15+
- 🧠 **Mind mapping** platform for organizing thoughts
16+
- 🎯 **Goal planning** dashboard for tracking progress
17+
- 🧘 **Meditation** with guided sessions and relaxing music
18+
- 🌱 **Habit tracking** in a beautiful garden simulator format
19+
20+
## ✨ Features
21+
22+
### Garden of Thoughts - To Grow
23+
24+
Create space for your goals and find inner peace:
25+
26+
- **Breathing Techniques**: Scientifically approved collection to help you concentrate during work
27+
- **Meditation Library**: Rich playlist of meditation lessons recorded by professional voice actors
28+
- **Relaxation Sounds**: Nature sounds and binaural beats for deep & better sleep
29+
- **Training Programs**: Body relaxation, contrast showering, yoga, sadhu board & stretching
30+
31+
### Forest of Habits - To Build
32+
33+
Build an unbreakable shell of mindfulness and control:
34+
35+
- **Daily Tasks**: Connect strong habits, gain self-control, and reach life-mindfulness
36+
- **Garden Simulator**: Make yourself better in game format - water habits, goals, and thoughts like trees
37+
- **Quit Addictions**: Use habit reversal training (HRT) or cognitive-behavioral therapy (CBT)
38+
39+
## 🗺️ Project Roadmap
40+
41+
### Phase I: Breathwork Exercises Library (Current)
42+
43+
Playlist of breathing & meditation sessions including:
44+
45+
- Wim Hof, Holotropic, Sitali Pranayama breathing techniques
46+
- 100+ meditation lessons by certified psychologists
47+
- AI-generated endless relaxing tracks with nature sounds and binaural rhythms
48+
49+
### Phase II: Physical Exercises Library (Coming Soon)
50+
51+
Yoga, stretching & willpower boost lessons:
52+
53+
- Relaxing yoga sequences with full list of asanas and pranayamas
54+
- Sadhu standing board sessions for physical & emotional energy
55+
- Full-body functional exercises and workout programs
56+
57+
### Phase III: Improvements Scheduler
58+
59+
Life journal, goals planner & habits tracker:
60+
61+
- Personal diary and daily mood tracker with reminders
62+
- Mind mapping interface for goal planning and self-analysis
63+
- Addictions tracker based on HRT and CBT
64+
65+
### Phase IV: Virtual Personal Garden
66+
67+
Any thought is a tree, any idea is a flower:
68+
69+
- Garden Simulator format for habits, goals, and mood tracking
70+
- Get rid of anxiety/depression signs with focused meditation
71+
- Water your trees with regular exercises using gamification mechanics
72+
73+
## 🛠️ Tech Stack
74+
75+
- **Framework**: [Astro](https://astro.build) - Modern static site generator
76+
- **Styling**: [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS framework
77+
- **UI Library**: [TailyUI](https://tailyui.by.nikdelv.in) - Pure Tailwind CSS UI components
78+
- **Language**: TypeScript - Type-safe JavaScript
79+
- **Deployment**: Firebase Hosting
80+
81+
## 🚀 Getting Started
82+
83+
### Prerequisites
84+
85+
- Node.js (latest LTS version recommended)
86+
- npm or yarn package manager
87+
88+
### Installation
89+
90+
```bash
91+
# Clone the repository
92+
git clone https://github.com/nikdelvin/feelicy.git
93+
cd feelicy
94+
95+
# Install dependencies
96+
npm install
797
```
898

9-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11-
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
12-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
99+
### Development
13100

14-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
101+
```bash
102+
# Start development server with linting and formatting
103+
npm run start
15104

16-
## 🚀 Project Structure
105+
# Or just run Astro dev server
106+
npm run dev
107+
```
108+
109+
The site will be available at `http://localhost:4321`
110+
111+
### Build
17112

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

117+
# Preview production build
118+
npm run preview
20119
```
21-
.
22-
├── public/
120+
121+
## 📁 Project Structure
122+
123+
```text
124+
feelicy/
125+
├── public/ # Static assets (favicons, media files, audio)
126+
│ └── media/ # Game assets and UI images
127+
│ └── Farm/ # Farm game animations and sprites
23128
├── src/
24-
│ ├── assets/
25-
│ ├── content/
26-
│ │ ├── docs/
27-
│ └── content.config.ts
28-
├── astro.config.mjs
29-
├── package.json
30-
└── tsconfig.json
129+
│ ├── assets/ # Optimized image assets
130+
│ ├── components/ # Reusable Astro & React components
131+
│ │ ├── BlockQuote.astro
132+
│ │ ├── Grad.astro
133+
│ │ ├── MediaPlayer.astro
134+
│ │ └── PixelGame/ # Game component with animations
135+
│ │ ├── Game.tsx
136+
│ │ ├── levels.ts
137+
│ │ ├── utils.ts
138+
│ │ └── style.css
139+
│ ├── content/ # Markdown content collections
140+
│ │ └── docs/
141+
│ │ ├── index.mdx
142+
│ │ ├── mindful-garden.mdx
143+
│ │ └── podcasts/ # Podcast episode content
144+
│ ├── styles/ # Global CSS
145+
│ │ └── global.css
146+
│ └── content.config.ts # Content configuration
147+
├── astro.config.mjs # Astro configuration
148+
├── tailwind.config.ts # Tailwind CSS configuration
149+
├── tsconfig.json # TypeScript configuration
150+
├── eslint.config.mjs # ESLint configuration
151+
├── prettier.config.mjs # Prettier configuration
152+
├── firebase.json # Firebase deployment config
153+
└── package.json # Dependencies and scripts
31154
```
32155

33-
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.
156+
## 📜 Available Scripts
157+
158+
| Command | Description |
159+
| ------------------ | ------------------------------------------------------ |
160+
| `npm run start` | Formats, lints, and starts dev server |
161+
| `npm run build` | Formats, lints, type-checks, and builds for production |
162+
| `npm run preview` | Preview production build locally |
163+
| `npm run eslint` | Run ESLint on TypeScript and Astro files |
164+
| `npm run prettier` | Format all files with Prettier |
165+
166+
## 👨‍💻 Creator
167+
168+
Created by [Nikita Stadnik](https://nikdelv.in) - Passionate Fullstack Web Developer
169+
170+
- 📧 Email: [the@nikdelv.in](mailto:the@nikdelv.in)
171+
- 🐙 GitHub: [@nikdelvin](https://github.com/nikdelvin)
172+
- 💼 LinkedIn: [@nikdelvin](https://www.linkedin.com/in/nikdelvin)
173+
174+
## 🔗 Related Projects
34175

35-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
176+
- [TailyUI](https://tailyui.app.nikdelv.in) - Modern UI Library built with pure Tailwind CSS
177+
- [Brodly](https://brodly.app.nikdelv.in) - High-secure anonymous live-streaming platform
178+
- [Scientry](https://scientry.app.nikdelv.in) - Data management & visualization tool
179+
- [Scripty](https://scripty.app.nikdelv.in) - Practice-oriented educational platform to learn JavaScript
180+
- [Neuroly](https://neuroly.app.nikdelv.in) - STT and voice synthesis AI chatbot
36181

37-
Static assets, like favicons, can be placed in the `public/` directory.
182+
## 📄 License
38183

39-
## 🧞 Commands
184+
This project is licensed under the terms specified in the [LICENSE](./LICENSE) file.
40185

41-
All commands are run from the root of the project, from a terminal:
186+
## 🤝 Contributing
42187

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

52-
## 👀 Want to learn more?
190+
---
53191

54-
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).
192+
**Plant your first tree today!** 🌱 Visit [feelicy.app.nikdelv.in](https://feelicy.app.nikdelv.in)

0 commit comments

Comments
 (0)