|
1 | | -# Astro Starter Kit: Basics |
| 1 | +# 🧬 Scientry |
2 | 2 |
|
3 | | -```sh |
4 | | -npm create astro@latest -- --template basics |
| 3 | +> Build beautiful dashboards with compact, easy-to-use, and fully customizable CMS for Data Management |
| 4 | +
|
| 5 | +Self-hosted, all-in-one Data Management & Visualization solution for scientific researchers. |
| 6 | + |
| 7 | +[](https://scientry.by.nikdelv.in) |
| 8 | +[](https://scientry.app.nikdelv.in) |
| 9 | +[](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**: [Astro](https://astro.build) - Modern static site generator |
| 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-website.git |
| 96 | +cd scientry-website |
| 97 | + |
| 98 | +# Install dependencies |
| 99 | +npm install |
5 | 100 | ``` |
6 | 101 |
|
7 | | -[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) |
8 | | -[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) |
9 | | -[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) |
| 102 | +### Development |
10 | 103 |
|
11 | | -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
| 104 | +```bash |
| 105 | +# Start development server with linting and formatting |
| 106 | +npm run start |
12 | 107 |
|
13 | | - |
| 108 | +# Or just run Astro dev server |
| 109 | +npm run dev |
| 110 | +``` |
| 111 | + |
| 112 | +The site will be available at `http://localhost:4321` |
14 | 113 |
|
15 | | -## 🚀 Project Structure |
| 114 | +### Build |
16 | 115 |
|
17 | | -Inside of your Astro project, you'll see the following folders and files: |
| 116 | +```bash |
| 117 | +# Build for production (includes linting and type checking) |
| 118 | +npm run build |
| 119 | + |
| 120 | +# Preview production build |
| 121 | +npm run preview |
| 122 | +``` |
| 123 | + |
| 124 | +## 📁 Project Structure |
18 | 125 |
|
19 | 126 | ```text |
20 | | -/ |
21 | | -├── public/ |
22 | | -│ └── favicon.svg |
| 127 | +scientry-website/ |
| 128 | +├── public/ # Static assets (favicons) |
23 | 129 | ├── src/ |
24 | | -│ ├── components/ |
25 | | -│ │ └── Card.astro |
26 | | -│ ├── layouts/ |
| 130 | +│ ├── layouts/ # Astro layout components |
27 | 131 | │ │ └── Layout.astro |
28 | | -│ └── pages/ |
29 | | -│ └── index.astro |
30 | | -└── package.json |
| 132 | +│ └── pages/ # Page routes |
| 133 | +│ └── [...theme].astro # Dynamic theme pages |
| 134 | +├── astro.config.mjs # Astro configuration |
| 135 | +├── tailwind.config.ts # Tailwind CSS configuration |
| 136 | +├── tsconfig.json # TypeScript configuration |
| 137 | +└── package.json # Dependencies and scripts |
31 | 138 | ``` |
32 | 139 |
|
33 | | -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. |
| 140 | +## 🎨 Available Themes |
| 141 | + |
| 142 | +The website supports multiple color themes: |
| 143 | + |
| 144 | +- Default |
| 145 | +- Primary |
| 146 | +- Secondary |
| 147 | +- Success |
| 148 | +- Warning |
| 149 | +- Error |
| 150 | +- Ghost |
| 151 | + |
| 152 | +Access different themes via URL: `https://scientry.by.nikdelv.in/[theme-name]` |
| 153 | + |
| 154 | +## 📜 Available Scripts |
| 155 | + |
| 156 | +| Command | Description | |
| 157 | +| ------------------ | ------------------------------------------------------ | |
| 158 | +| `npm run start` | Formats, lints, and starts dev server | |
| 159 | +| `npm run build` | Formats, lints, type-checks, and builds for production | |
| 160 | +| `npm run preview` | Preview production build locally | |
| 161 | +| `npm run eslint` | Run ESLint on TypeScript and Astro files | |
| 162 | +| `npm run prettier` | Format all files with Prettier | |
| 163 | +| `npm run upgrade` | Clean install all dependencies | |
| 164 | + |
| 165 | +## 👨💻 Creator |
| 166 | + |
| 167 | +Created by [Nikita Stadnik](https://nikdelv.in) - Passionate Fullstack Web Developer |
| 168 | + |
| 169 | +- 📧 Email: [the@nikdelv.in](mailto:the@nikdelv.in) |
| 170 | +- 🐙 GitHub: [@nikdelvin](https://github.com/nikdelvin) |
| 171 | +- 💼 LinkedIn: [@nikdelvin](https://www.linkedin.com/in/nikdelvin) |
| 172 | + |
| 173 | +## 🔗 Related Projects |
34 | 174 |
|
35 | | -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. |
| 175 | +- [TailyUI](https://tailyui.by.nikdelv.in) - Modern UI Library built with pure Tailwind CSS |
| 176 | +- [Brodly](https://brodly.by.nikdelv.in) - High-secure anonymous live-streaming platform |
| 177 | +- [Feelicy](https://feelicy.by.nikdelv.in) - Self-improvement platform with meditation and habit tracking |
| 178 | +- [Scripty](https://scripty.by.nikdelv.in) - Practice-oriented educational platform to learn JavaScript |
| 179 | +- [Neuroly](https://neuroly.by.nikdelv.in) - STT and voice synthesis AI chatbot |
36 | 180 |
|
37 | | -Any static assets, like images, can be placed in the `public/` directory. |
| 181 | +## 📄 License |
38 | 182 |
|
39 | | -## 🧞 Commands |
| 183 | +This project is licensed under the terms specified in the [LICENSE](./LICENSE) file. |
40 | 184 |
|
41 | | -All commands are run from the root of the project, from a terminal: |
| 185 | +## 🤝 Contributing |
42 | 186 |
|
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 | |
| 187 | +Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/nikdelvin/scientry-website/issues). |
51 | 188 |
|
52 | | -## 👀 Want to learn more? |
| 189 | +--- |
53 | 190 |
|
54 | | -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
| 191 | +**Start managing your research data today!** 🧬 Visit [scientry.by.nikdelv.in](https://scientry.by.nikdelv.in) |
0 commit comments