Skip to content

Commit cc552fb

Browse files
arghyaxcodesarghyaxcodes
committed
docs(readme): update README with better info
1 parent 587bd65 commit cc552fb

File tree

2 files changed

+139
-60
lines changed

2 files changed

+139
-60
lines changed

‎.github/img/javaistic-readme.png‎

225 KB
Loading

‎README.md‎

Lines changed: 139 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,110 +1,189 @@
1-
<div align=center>
1+
<div align="center">
22

33
<br>
44

5-
<img height=70 src="https://raw.githubusercontent.com/javaistic/.github/main/profile/img/logo-light.svg#gh-dark-mode-only">
6-
<img height=70 src="https://raw.githubusercontent.com/javaistic/.github/main/profile/img/logo-dark.svg#gh-light-mode-only">
5+
<img height="70" alt="Javaistic Logo" src="https://raw.githubusercontent.com/javaistic/.github/main/profile/img/logo-light.svg#gh-dark-mode-only">
6+
<img height="70" alt="Javaistic Logo" src="https://raw.githubusercontent.com/javaistic/.github/main/profile/img/logo-dark.svg#gh-light-mode-only">
77

8+
<br>
89
<br>
910

10-
### [![Stars](https://badgen.net/github/stars/javaistic/javaistic)](https://github.com/javaistic/javaistic/stargazers) [![Release](https://badgen.net/github/release/javaistic/javaistic)](https://github.com/javaistic/javaistic/releases) [![CodeQL](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml) [![License](https://badgen.net/github/license/javaistic/javaistic)](LICENSE) [![Better Uptime Badge](https://betteruptime.com/status-badges/v1/monitor/8a3u.svg)](https://javaistic.betteruptime.com/?utm_source=status_badge)
11+
**A modern, open-source, comprehensive platform for mastering Java programming**
1112

12-
</div>
13+
<br>
1314

14-
<div align="center">
15+
[![Stars](https://img.shields.io/github/stars/javaistic/javaistic?style=flat&logo=github&color=yellow)](https://github.com/javaistic/javaistic/stargazers)
16+
[![Forks](https://img.shields.io/github/forks/javaistic/javaistic?style=flat&logo=github&color=blue)](https://github.com/javaistic/javaistic/network/members)
17+
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE.md)
18+
[![Issues](https://img.shields.io/github/issues/javaistic/javaistic?style=flat&logo=github&color=red)](https://github.com/javaistic/javaistic/issues)
19+
[![Pull Requests](https://img.shields.io/github/issues-pr/javaistic/javaistic?style=flat&logo=github&color=purple)](https://github.com/javaistic/javaistic/pulls)
20+
[![CodeQL](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml)
21+
[![Status](https://betteruptime.com/status-badges/v1/monitor/8a3u.svg)](https://javaistic.betteruptime.com/?utm_source=status_badge)
22+
23+
### [🌐 Visit Site](https://javaistic.vercel.app/) • [📝 Blog](https://javaistic.vercel.app/blog) • [📋 Changelog](https://javaistic.vercel.app/changelog) • [📊 Status](https://javaistic.vercel.app/status)
24+
25+
<br>
26+
27+
[![Javaistic Platform Preview](.github/img/javaistic-readme.png)](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-image&utm_campaign=javaistic)
1528

16-
### [Visit Javaistic Site](https://javaistic.vercel.app/) • [View Changelog](https://javaistic.vercel.app/changelog) • [Check Status](https://javaistic.vercel.app/status)
29+
## [Explore Javaistic →](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-link&utm_campaign=javaistic)
1730

1831
</div>
1932

20-
<div align="center">
33+
## 🎯 Overview
2134

22-
[![javaistic](.github/img/javaistic-readme.png)](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-image&utm_campaign=javaistic)
35+
Javaistic is a modern, open-source learning platform designed to help developers master Java programming from fundamentals to advanced concepts. Built with cutting-edge web technologies, it provides an interactive, distraction-free environment with comprehensive documentation, hands-on programs, and real-world examples.
2336

24-
### Explore Javaistic ⟶ [javaistic.vercel.app](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-link&utm_campaign=javaistic)
37+
### Why Javaistic?
2538

26-
</div>
39+
- **📚 Comprehensive Curriculum** - Complete Java learning path from basics to advanced topics
40+
- **💻 Hands-On Practice** - A lot of practical programs with detailed explanations
41+
- **🎨 Modern UI/UX** - Beautiful, responsive design with dark/light mode support
42+
- **⚡ Lightning Fast** - Optimized performance powered by Next.js 15 and Turbopack
43+
- **🔍 Smart Search** - Advanced search with intelligent filtering
44+
- **📱 Mobile-Ready** - Seamless experience across all devices
45+
- **🆓 Completely Free** - No ads, no paywalls, just learning
46+
- **♿ Accessible** - Built following WCAG standards
2747

28-
## 📄 Description
48+
## ✨ Key Features
2949

30-
Javaistic is a comprehensive website for learning Java programming, packed with detailed information and programs covering everything from basics to advanced topics, including arrays, strings, 2D arrays, recursion, matrices, and more.
50+
### 🎓 Learning Resources
3151

32-
## 🔥 Features
52+
#### Documentation
3353

34-
- **Beautiful Design:** Enjoy a visually appealing and optimized learning experience.
35-
- **Comprehensive Content:** Easily understandable Java docs and programs for learners at all levels.
36-
- **Open Source:** Everything is free and open source, encouraging a collaborative learning environment.
37-
- **Ad Free:** Study without distractions - Javaistic is ad-free for an uninterrupted learning experience.
54+
- **Fundamentals** - Variables, data types, operators, control structures
55+
- **OOP Concepts** - Classes, objects, inheritance, polymorphism, encapsulation
56+
- **Advanced Topics** - Generics, collections, streams, lambda expressions
57+
- **Design Patterns** - Creational, structural, and behavioral patterns
58+
- **Database Integration** - JDBC basics and CRUD operations
59+
- **Concurrency** - Multithreading and synchronization
60+
- **Networking** - TCP/UDP socket programming
61+
- **GUI Development** - Swing basics, event handling, layout managers
3862

39-
## 🪴 Project Activity
63+
#### Practical Programs
4064

41-
![Repobeats Analytics](https://repobeats.axiom.co/api/embed/3df6f52cbd6d58e6c248f9457081834adf6459e5.svg "Repobeats analytics image")
65+
- Number operations (factorial, Fibonacci, prime numbers)
66+
- Mathematical calculations (compound interest, GCD/LCM)
67+
- Array manipulations and algorithms
68+
- Date and time utilities
69+
- Binary number operations
70+
- And more!
71+
72+
### 🛠️ Technology Stack
73+
74+
| Category | Technologies |
75+
| ------------------- | ------------------------------------- |
76+
| **Framework** | Next.js 15 (App Router) |
77+
| **Language** | TypeScript |
78+
| **Styling** | Tailwind CSS 4.x |
79+
| **Content** | Fumadocs (MDX) |
80+
| **Fonts** | Inter, Funnel Display, JetBrains Mono |
81+
| **Analytics** | Google Analytics |
82+
| **Deployment** | Vercel |
83+
| **Package Manager** | Bun |
4284

43-
## 🧑‍💻 Contributing
85+
## 🚀 Getting Started
4486

45-
Interested in contributing to Javaistic Documentation? Please read our [contributing guidelines](CONTRIBUTING.md) before submitting a pull request.
87+
### Prerequisites
4688

47-
### Running Locally
89+
- [Bun](https://bun.sh/) (recommended) or Node.js 18+
90+
- Git
4891

49-
To develop locally, follow these steps:
92+
### Installation
5093

51-
1. **Clone this repo:**
94+
```bash
95+
# Clone the repository
96+
git clone https://github.com/javaistic/javaistic.git
5297

53-
```sh
54-
git clone https://github.com/javaistic/javaistic.git
55-
```
98+
# Navigate to the project directory
99+
cd javaistic
56100

57-
2. **Navigate to the project root directory:**
101+
# Install dependencies
102+
bun install
58103

59-
```sh
60-
cd javaistic
61-
```
104+
# Start the development server
105+
bun run dev
106+
```
62107

63-
3. **Install dependencies:**
108+
The application will be available at `http://localhost:3000`.
64109

65-
```sh
66-
bun i
67-
```
110+
### Available Scripts
68111

69-
4. **Start the development server:**
112+
```bash
113+
bun run dev # Start development server with Turbo
114+
bun run build # Build for production
115+
bun run start # Start production server
116+
bun run lint # Run ESLint
117+
bun run format # Format code with Prettier
118+
```
70119

71-
```sh
72-
bun run dev
73-
```
120+
## 🤝 Contributing
74121

75-
## 🤝 Community
122+
We welcome contributions from the community! Whether you're fixing bugs, adding features, improving documentation, or creating new Java programs, your help makes Javaistic better.
76123

77-
Join the Javaistic community on [GitHub Discussions](https://github.com/javaistic/javaistic/discussions) to ask questions, share ideas, and showcase your projects.
124+
### How to Contribute
78125

79-
<!--
80-
For real-time communication, you can also join the [Javaistic Discord Server](https://javaistic.vercel.app/discord).
81-
-->
126+
1. **Fork the repository**
127+
2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
128+
3. **Commit your changes** (`git commit -m 'Add amazing feature'`)
129+
4. **Push to the branch** (`git push origin feature/amazing-feature`)
130+
5. **Open a Pull Request**
82131

83-
Please review our [Code of Conduct](CODE_OF_CONDUCT.md) for all community interactions.
132+
Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting contributions.
84133

85-
## Author
134+
### Contribution Areas
86135

87-
- Arghya Ghosh [(@uiuxarghya)](https://twitter.com/uiuxarghya)
136+
- 🐛 Bug fixes and issue resolution
137+
- 📝 Documentation improvements
138+
- 💡 New Java programs and examples
139+
- 🎨 UI/UX enhancements
140+
- ⚡ Performance optimizations
141+
- 🌐 Translations and localization
88142

89-
## Contributors
143+
## 📊 Project Stats
90144

91-
[![](https://contrib.rocks/image?repo=javaistic/javaistic)](https://github.com/javaistic/javaistic/graphs/contributors)
145+
![Repobeats Analytics](https://repobeats.axiom.co/api/embed/3df6f52cbd6d58e6c248f9457081834adf6459e5.svg "Repobeats analytics image")
146+
147+
## 💬 Community & Support
148+
149+
### Get Involved
150+
151+
- **[💡 Discussions](https://github.com/javaistic/javaistic/discussions)** - Ask questions, share ideas
152+
- **[🐛 Issues](https://github.com/javaistic/javaistic/issues)** - Report bugs or request features
153+
- **[📋 Changelog](https://javaistic.vercel.app/changelog)** - Track updates and releases
154+
155+
### Community Guidelines
156+
157+
- Follow our [Code of Conduct](CODE_OF_CONDUCT.md)
158+
- Be respectful and constructive
159+
- Help fellow learners
160+
- Share knowledge and experiences
161+
162+
## 👥 Team
92163

93-
## 📝 License
164+
**Founder & Lead Developer**
94165

95-
This project uses a **dual license**.
96-
Please refer to the main [`LICENSE.md`](./LICENSE.md) file for complete details.
166+
- [Arghya Ghosh](https://twitter.com/uiuxarghya) ([@uiuxarghya](https://github.com/uiuxarghya))
97167

98-
- Code is licensed under the **GNU AGPL v3**.
99-
- Documentation and content are licensed under the **CC BY-NC-SA 4.0**.
168+
**Contributors**
100169

101-
## 💖 Acknowledgements
170+
We're grateful to all our contributors who help make Javaistic better:
102171

103-
Special thanks to the following companies for their support in building Javaistic:
172+
[![Contributors](https://contrib.rocks/image?repo=javaistic/javaistic)](https://github.com/javaistic/javaistic/graphs/contributors)
173+
174+
## 🪪 License
175+
176+
This project uses a dual-license model:
177+
178+
- **Code**: Licensed under [GNU AGPL v3](./licenses/LICENSE-AGPL.md)
179+
- **Documentation & Content**: Licensed under [CC BY-NC-SA 4.0](./licenses/LICENSE-CC.md)
180+
181+
See [LICENSE.md](./LICENSE.md) for complete details.
182+
183+
## 💖 Acknowledgments
184+
185+
Special thanks to our sponsors and supporters:
104186

105187
[![Powered by Vercel](.github/img/powered-by-vercel.svg)](https://vercel.com/?utm_source=javaistic&utm_campaign=oss)
106-
[![Search by Algolia](.github/img/search-by-algolia.svg)](https://algolia.com/?utm_source=javaistic&utm_campaign=oss)
107188
[![JetBrains](.github/img/jetbrains.svg)](https://jetbrains.com/?utm_source=javaistic&utm_campaign=oss)
108189
[![Forms by Formspree](.github/img/forms-by-formspree.svg)](https://formspree.io/?utm_source=javaistic&utm_campaign=oss)
109-
110-
**Made with ❤️ in India by [Arghya Ghosh](https://github.com/uiuxarghya)**

0 commit comments

Comments
 (0)