Skip to content

Commit 1d177cf

Browse files
committed
Updating README.md File
1 parent 5b67a1b commit 1d177cf

File tree

4 files changed

+3664
-7549
lines changed

4 files changed

+3664
-7549
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 9 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
> ⚠️ **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**.
33
> _Please keep regular backups of your data!_
44
55
<div align="center" style="margin-bottom: 20px;">
@@ -30,7 +30,11 @@
3030

3131
<p align="center">
3232
<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>
3438
</p>
3539
<p align="center">
3640
<h3>πŸ“ˆ Charts</h3><br>
@@ -57,53 +61,16 @@
5761

5862
- 🎨 **Frontend:** SvelteKit, Tailwind CSS
5963
- πŸ–₯️ **Backend:** Node.js, Express.js
60-
- πŸ—„οΈ **Database:** SQLite
61-
- πŸ“š **Documentation:** VitePress
64+
- πŸ—„οΈ **Database:** SQLite, sequelize ORM
6265
- 🐳 **Containerization:** Docker & Docker Compose
6366

6467
## πŸš€ Getting Started
6568

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.
10370

10471
## 🀝 Contributing
10572

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. πŸ™
10774

10875
## πŸ“„ License
10976

96.6 KB
Loading
105 KB
Loading

0 commit comments

Comments
Β (0)