Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shotnothing authored Apr 25, 2024
1 parent c4c5b4d commit a30391b
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@ This is a repo for the API server that powers the PriceProbe platform, as well a
Currently, this is a monorepo with all our code in one place. Do take a look at each individual folder for each component of this platform and feel free to raise an [issue](https://github.com/shotnothing/TeamPower8/issues) or start a [discussion](https://github.com/shotnothing/TeamPower8/discussions).

## Quickstart
#### Prerequesites
#### Installation
First, clone the repo

```
git clone https://github.com/shotnothing/TeamPower8.git
```

#### Setup
Before starting the backend, you will need a Supabase account and setup the authentication and tables, as shown in our [wiki](https://github.com/shotnothing/TeamPower8/wiki).

You will also need to compute the analytics. It will take a very long time without a GPU, so we have provided the precaulclated analytics results in a seperate git repo. To use it, do
Expand All @@ -31,7 +38,7 @@ mkdir ./analytics/export
python ./analytics/analytics.py
```

#### Setup
#### Running
To start both the frontend and backend, do
```bash
docker-compose up
Expand Down

0 comments on commit a30391b

Please sign in to comment.