|
1 | 1 | > β οΈ **WARNING:** |
2 | | -> Tracktor is under very active development. There may be frequent breaking changes, and it is **not stable for production use**. |
| 2 | +> Tracktor is under active development. There may be frequent breaking changes, though we are taking precautions but it is **not stable for production use**. |
3 | 3 | > _Please keep regular backups of your data!_ |
4 | 4 |
|
5 | 5 | <div align="center" style="margin-bottom: 20px;"> |
|
30 | 30 |
|
31 | 31 | <p align="center"> |
32 | 32 | <h3>π Login Page</h3><br> |
33 | | - <img src="app/docs/public/screenshots/login.png" alt="Login Page" width="90%" style="border-radius: 10px; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);"> |
| 33 | + <picture style="border-radius: 10px"> |
| 34 | + <source media="(prefers-color-scheme: dark)" srcset="./docs/screenshots/login-dark.png" /> |
| 35 | + <source media="(prefers-color-scheme: light)" srcset="./docs/screenshots/login-light.png" /> |
| 36 | + <img alt="Login Page" src="./docs/screenshots/login-light.png" /> |
| 37 | + </picture> |
34 | 38 | </p> |
35 | 39 | <p align="center"> |
36 | 40 | <h3>π Charts</h3><br> |
|
57 | 61 |
|
58 | 62 | - π¨ **Frontend:** SvelteKit, Tailwind CSS |
59 | 63 | - π₯οΈ **Backend:** Node.js, Express.js |
60 | | -- ποΈ **Database:** SQLite |
61 | | -- π **Documentation:** VitePress |
| 64 | +- ποΈ **Database:** SQLite, sequelize ORM |
62 | 65 | - π³ **Containerization:** Docker & Docker Compose |
63 | 66 |
|
64 | 67 | ## π Getting Started |
65 | 68 |
|
66 | | -### π¦ Prerequisites |
67 | | - |
68 | | -- π’ Node.js (v18 or higher) |
69 | | -- π¦ npm |
70 | | -- π³ Docker & Docker Compose (for containerized setup) |
71 | | - |
72 | | -### π οΈ Installation (Development) |
73 | | - |
74 | | -1. **Clone the repository:** |
75 | | - ```bash |
76 | | - git clone https://github.com/your-username/tracktor.git |
77 | | - cd tracktor |
78 | | - ``` |
79 | | -2. **Install dependencies:** |
80 | | - ```bash |
81 | | - npm install |
82 | | - ``` |
83 | | -3. **Set up environment:** |
84 | | - ```bash |
85 | | - npm run setup |
86 | | - ``` |
87 | | -4. **Start the development server:** |
88 | | - ```bash |
89 | | - npm run dev |
90 | | - ``` |
91 | | -5. **Open your browser:** |
92 | | - Navigate to `http://localhost:5173` for the frontend. |
93 | | - |
94 | | -### π³ Running with Docker Compose |
95 | | - |
96 | | -1. **Build and start all services:** |
97 | | - ```bash |
98 | | - docker-compose up --build |
99 | | - ``` |
100 | | -2. **Access the app:** |
101 | | - - π Main App: `http://localhost:3000` |
102 | | - - π Docs: `http://localhost:5173` |
| 69 | +Please check the [installation guide](./docs/INSTALL.md) for detailed instructions on setting up the project. |
103 | 70 |
|
104 | 71 | ## π€ Contributing |
105 | 72 |
|
106 | | -Contributions are welcome! Please read the [contributing guidelines](app/docs/developer-guide/contributing/) before submitting a pull request. π |
| 73 | +Contributions are welcome! Please read the [contributing guidelines](./docs/CONTRIBUTING.md) before submitting a pull request. π |
107 | 74 |
|
108 | 75 | ## π License |
109 | 76 |
|
|
0 commit comments