darabos commited on
Commit
1ac38b4
·
1 Parent(s): 40a8895

Basic README.md.

Browse files
Files changed (1) hide show
  1. README.md +22 -0
README.md ADDED
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # LynxKite 2024
2
+
3
+ This is an experimental rewrite of [LynxKite](https://github.com/lynxkite/lynxkite).
4
+ It is not compatible with the original LynxKite. For the design goals see
5
+ [LynxKite 2024 Roadmap](https://docs.google.com/document/d/12uhjib6M0bgdA9Ch5h4X8eBinmYOnzRa8bPwDWY0jtg/edit).
6
+
7
+ ## Installation
8
+
9
+ To run the backend:
10
+
11
+ ```bash
12
+ pip install -r requirements.txt
13
+ uvicorn server.main:app --reload
14
+ ```
15
+
16
+ To run the frontend:
17
+
18
+ ```bash
19
+ cd web
20
+ npm i
21
+ npm run dev
22
+ ```