Skip to content

Commit 077c0e8

Browse files
authored
docs: add roadmap in readme (#479)
1 parent cfcdd61 commit 077c0e8

1 file changed

Lines changed: 90 additions & 4 deletions

File tree

README.md

Lines changed: 90 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,112 @@
1616

1717
![build](https://github.com/kinotiodotio/drowser-studio/workflows/build/badge.svg)
1818

19-
Drowser Studio is a robust and intuitive app designed to help users track, visualize, and analyze the performance of various tests over time. 📈🚀
19+
Track, Visualize and Analyze
2020

2121
> This Drowser Studio depend from reports collected from the Drowser Deno Package who is available on Denoland 🦕
2222
2323
You can find the `Drowser` lib from Denoland [here](https://deno.land/x/drowser)
2424

2525
## Setup
2626

27+
### Services
28+
29+
You need to have Docker installed on your machine. you can check [here](https://docs.docker.com/get-docker/) for installation instructions.
30+
31+
Run the docker compose file by executing the following command:
32+
33+
```bash
34+
$ docker-compose up -d
35+
```
36+
37+
### Application
38+
2739
Install dependencies:
2840

2941
```bash
3042
$ pnpm install
3143
```
3244

33-
And then install Infisical CLI [here](https://infisical.com/docs/cli/overview), then run the following command:
45+
And then install Infisical CLI [here](https://infisical.com/docs/cli/overview), then run these following commands:
46+
47+
Run database migration by executing the following command:
48+
49+
```bash
50+
$ infisical run --env=dev --watch --recursive -- pnpm run db:migrate
51+
```
52+
53+
And, Run the application by executing the following command:
54+
55+
```bash
56+
$ infisical run --env=dev --watch --recursive -- pnpm dev
57+
```
58+
59+
Or, if you don't have access to our Infisical, you can set all the environment variables from the `.env.example` file to your `.env` file by creating a new `.env` file in the root directory, and then running these following commands:
60+
61+
Run database migration by executing the following command:
3462

3563
```bash
36-
$ infisical run -- pnpm run dev
64+
$ pnpm run db:migrate
3765
```
3866

67+
And, Run the application by executing the following command:
68+
69+
```bash
70+
$ pnpm dev
71+
```
72+
73+
## Roadmap
74+
75+
### Resume Features
76+
77+
- [ ] **Templates & Customization**
78+
- [ ] Multiple resume layout options/themes
79+
- [ ] Custom color schemes
80+
- [ ] Font customization options
81+
- [ ] Custom section ordering
82+
83+
### Report Enhancement
84+
85+
- [ ] **Advanced Visualizations**
86+
- [ ] Interactive dashboard components
87+
- [ ] Custom chart types and configurations
88+
- [ ] Data filtering and sorting options
89+
- [ ] Export visualizations as PNG/PDF
90+
91+
- [ ] **AI-Powered Analytics**
92+
- [ ] Trend detection and insights
93+
- [ ] Anomaly detection
94+
- [ ] Predictive analytics
95+
- [ ] Natural language report summaries
96+
97+
### User Experience
98+
99+
- [ ] **Collaboration Features**
100+
- [ ] Shared workspaces
101+
- [ ] Comment and annotation system
102+
- [ ] Real-time collaboration
103+
- [ ] Role-based access control
104+
105+
- [ ] **Workflow Integration**
106+
- [ ] Custom notification rules
107+
- [ ] Integration with CI/CD pipelines
108+
- [ ] Webhooks for external systems
109+
- [ ] API extensions for custom integrations
110+
111+
### Infrastructure
112+
113+
- [ ] **Performance Optimizations**
114+
- [ ] Server-side caching
115+
- [ ] Database query optimization
116+
- [ ] Lazy-loading for large datasets
117+
- [ ] Background processing for heavy tasks
118+
119+
- [ ] **Mobile Support**
120+
- [ ] Responsive mobile interface
121+
- [ ] Native mobile application
122+
- [ ] Offline capabilities
123+
- [ ] Push notifications
124+
39125
## License
40126

41-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
127+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)