Skip to content

Commit b546e78

Browse files
authored
Merge pull request #1 from remotehack/add-readme
feat: Add README.md
2 parents bd4d40e + 8dce8c4 commit b546e78

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Cycloops
2+
3+
A web application for tracking cycling routes.
4+
5+
## Features
6+
7+
- Track cycling routes
8+
- View routes on a map
9+
- View a list of routes
10+
11+
## Tech Stack
12+
13+
- [Vite](https://vitejs.dev/)
14+
- [TypeScript](https://www.typescriptlang.org/)
15+
- [Preact Signals](https://preactjs.com/guide/v10/signals/)
16+
- [Turf.js](https://turfjs.org/)
17+
- [date-fns](https://date-fns.org/)
18+
- [Dexie.js](https://dexie.org/)
19+
- [MapLibre GL JS](https://maplibre.org/)
20+
21+
## Getting Started
22+
23+
### Installation
24+
25+
1. Clone the repo
26+
```sh
27+
git clone https://github.com/user/repo.git
28+
```
29+
2. Install NPM packages
30+
```sh
31+
npm install
32+
```
33+
34+
### Running the project
35+
36+
```sh
37+
npm run dev
38+
```
39+
40+
## License
41+
42+
Distributed under the MIT License. See `LICENSE` for more information.

0 commit comments

Comments
 (0)