Skip to content

Commit e66a120

Browse files
nikdelvinnikdelvin
committed
README.md Update
1 parent 9058205 commit e66a120

File tree

4 files changed

+1004
-836
lines changed

4 files changed

+1004
-836
lines changed

‎README.md‎

Lines changed: 178 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,194 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
# 🧬 Scientry
22

3-
## Getting Started
3+
> Build beautiful dashboards with compact, easy-to-use, and fully customizable CMS for Data Management
44
5-
First, run the development server:
5+
Self-hosted, all-in-one Data Management & Visualization solution for scientific researchers.
6+
7+
[![Live Website](https://img.shields.io/badge/🌐_Live-scientry.by.nikdelv.in-success)](https://scientry.by.nikdelv.in)
8+
[![App](https://img.shields.io/badge/🚀_App-scientry.app.nikdelv.in-primary)](https://scientry.app.nikdelv.in)
9+
[![GitHub](https://img.shields.io/badge/GitHub-nikdelvin/scientry-blue)](https://github.com/nikdelvin/scientry)
10+
11+
## 🌟 Overview
12+
13+
Scientry is a powerful self-hosted data management and visualization platform designed specifically for scientific researchers and data analysts. It combines:
14+
15+
- 📊 **Data Management** - Fast relational SQLite database for efficient data storage
16+
- 📈 **Visualization Core** - Advanced charts and graphs powered by D3.js library
17+
- 🎨 **Accessible UI** - Clean, intuitive interface designed for productivity
18+
- 🔓 **100% Free SDK** - Open-source solution for complete self-hosting control
19+
20+
## ✨ Features
21+
22+
### Sci-Fi CMS
23+
24+
Content Management System for any research and data analysis:
25+
26+
- **Fast Database**: Powered with fast relational SQLite database for reliable data storage
27+
- **Advanced Visualization**: Data visualization core based on D3.js library for complex charts and graphs
28+
- **Accessible Design**: UI designed for accessibility and ease of use
29+
- **Self-Hosted**: 100% free SDK for self-hosting with complete data ownership
30+
31+
### Under the Hood
32+
33+
- **Fast Relational Database**: Efficient data storage and retrieval with SQLite
34+
- **Visualization Core**: Complex visualization capabilities for scientific data
35+
- **Accessible UI**: Designed with user experience and accessibility in mind
36+
- **Free SDK**: Complete freedom for self-hosting and customization
37+
38+
## 🗺️ Project Roadmap
39+
40+
### Phase I: Core Data Management (Current)
41+
42+
Foundation for scientific data storage and management:
43+
44+
- Fast relational SQLite database for efficient data operations
45+
- Basic CRUD operations for research data
46+
- Data import/export capabilities
47+
- User authentication and authorization
48+
49+
### Phase II: Advanced Visualization (Coming Soon)
50+
51+
Comprehensive data visualization toolkit:
52+
53+
- D3.js-powered interactive charts and graphs
54+
- Customizable dashboard layouts
55+
- Real-time data updates and streaming
56+
- Export visualizations in multiple formats (PNG, SVG, PDF)
57+
58+
### Phase III: Collaboration Features
59+
60+
Multi-user research environment:
61+
62+
- Team collaboration tools and shared workspaces
63+
- Version control for datasets and visualizations
64+
- Comment and annotation system
65+
- Role-based access control
66+
67+
### Phase IV: AI-Powered Analytics
68+
69+
Intelligent data analysis and insights:
70+
71+
- Automated pattern recognition and anomaly detection
72+
- Predictive analytics and forecasting
73+
- Natural language queries for data exploration
74+
- AI-assisted report generation
75+
76+
## 🛠️ Tech Stack
77+
78+
- **Framework**: [Next.JS](https://nextjs.org/) - The React Framework for the Web
79+
- **Styling**: [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS framework
80+
- **UI Library**: [TailyUI](https://tailyui.by.nikdelv.in) - Pure Tailwind CSS UI components
81+
- **Language**: TypeScript - Type-safe JavaScript
82+
- **Deployment**: Firebase Hosting
83+
84+
## 🚀 Getting Started
85+
86+
### Prerequisites
87+
88+
- Node.js (latest LTS version recommended)
89+
- npm or yarn package manager
90+
91+
### Installation
92+
93+
```bash
94+
# Clone the repository
95+
git clone https://github.com/nikdelvin/scientry.git
96+
cd scientry
97+
98+
# Install dependencies
99+
npm install
100+
```
101+
102+
### Development
6103

7104
```bash
8105
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15106
```
16107

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
108+
The site will be available at `http://localhost:3000`
109+
110+
### Build
111+
112+
```bash
113+
# Build for production (includes linting and type checking)
114+
npm run build
115+
116+
# Preview production build
117+
npm start
118+
```
119+
120+
## 📁 Project Structure
121+
122+
```text
123+
scientry/
124+
├── public/ # Static assets (favicons, images)
125+
│ ├── favicon.svg
126+
│ └── mockup.png
127+
├── src/
128+
│ ├── app/ # Next.js app directory
129+
│ │ ├── globals.css # Global styles
130+
│ │ ├── layout.tsx # Root layout
131+
│ │ ├── main.tsx # Main page component
132+
│ │ ├── page.tsx # Home page
133+
│ │ └── admin/ # Admin routes
134+
│ │ └── page.tsx
135+
│ ├── components/ # React components
136+
│ │ ├── forms/ # Form components
137+
│ │ │ ├── SchemaForm.tsx
138+
│ │ │ └── fields/ # Form field components
139+
│ │ ├── icons/ # Icon components
140+
│ │ └── menu/ # Menu components
141+
│ ├── pages/ # API routes
142+
│ │ └── api/
143+
│ │ └── ws/ # WebSocket API
144+
│ ├── types/ # TypeScript type definitions
145+
│ │ └── Field.d.ts
146+
│ ├── utils/ # Utility functions
147+
│ │ └── configs/
148+
│ └── state.ts # State management
149+
├── apphosting.yaml # Firebase App Hosting config
150+
├── next.config.mjs # Next.js configuration
151+
├── tailwind.config.ts # Tailwind CSS configuration
152+
├── postcss.config.js # PostCSS configuration
153+
├── tsconfig.json # TypeScript configuration
154+
├── scientry.db # SQLite database
155+
└── package.json # Dependencies and scripts
156+
```
157+
158+
## 📜 Available Scripts
159+
160+
| Command | Description |
161+
| ------------------ | ------------------------------------------------------ |
162+
| `npm run dev` | Formats, lints, and starts dev server |
163+
| `npm run build` | Formats, lints, type-checks, and builds for production |
164+
| `npm run start` | Preview production build locally |
165+
| `npm run lint` | Run ESLint on TypeScript and Astro files |
166+
| `npm run prettier` | Format all files with Prettier |
167+
168+
## 👨‍💻 Creator
169+
170+
Created by [Nikita Stadnik](https://nikdelv.in) - Passionate Fullstack Web Developer
18171

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
172+
- 📧 Email: [the@nikdelv.in](mailto:the@nikdelv.in)
173+
- 🐙 GitHub: [@nikdelvin](https://github.com/nikdelvin)
174+
- 💼 LinkedIn: [@nikdelvin](https://www.linkedin.com/in/nikdelvin)
20175

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
176+
## 🔗 Related Projects
22177

23-
## Learn More
178+
- [TailyUI](https://tailyui.app.nikdelv.in) - Modern UI Library built with pure Tailwind CSS
179+
- [Brodly](https://brodly.app.nikdelv.in) - High-secure anonymous live-streaming platform
180+
- [Feelicy](https://feelicy.app.nikdelv.in) - Self-improvement platform with meditation and habit tracking
181+
- [Scripty](https://scripty.app.nikdelv.in) - Practice-oriented educational platform to learn JavaScript
182+
- [Neuroly](https://neuroly.app.nikdelv.in) - STT and voice synthesis AI chatbot
24183

25-
To learn more about Next.js, take a look at the following resources:
184+
## 📄 License
26185

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
186+
This project is licensed under the terms specified in the [LICENSE](./LICENSE) file.
29187

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
188+
## 🤝 Contributing
31189

32-
## Deploy on Vercel
190+
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/nikdelvin/scientry/issues).
33191

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
192+
---
35193

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
194+
**Start managing your research data today!** 🧬 Visit [scientry.app.nikdelv.in](https://scientry.app.nikdelv.in)

0 commit comments

Comments
 (0)