Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tkv29 authored May 30, 2024
1 parent 073d13d commit c0838e9
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# TracEX

[![GitHub stars](https://img.shields.io/github/stars/bptlab/TracEX)](https://github.com/bptlab/TracEX)
[![GitHub open issues](https://img.shields.io/github/issues/bptlab/TracEX)](https://github.com/bptlab/TracEX/issues)
[![GitHub closed pull requests](https://img.shields.io/github/issues-closed/bptlab/TracEX)](https://github.com/bptlab/TracEX/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr/bptlab/TracEX)](https://github.com/bptlab/TracEX/issues)


## Key Points

Expand All @@ -10,6 +15,31 @@ Our project partner is mamahealth. More information about them can be found here
More information about the project will be released soon.


## Set Up Guide

### Download

- Use git and run "git clone https://github.com/bptlab/TracEX" in the desired directory _(Using e.g. Git Bash)_

### Installation
- navigate to the root directory of TracEX in your terminal
- run `install-dependencies-unix.sh` or `install-dependencies-windows.ps1`, based on your operating system _(Using e.g. Terminal)_
- run `python tracex/manage.py migrate` to update the database and apply all changes stored in the `migrations` folder

### Execution

**Web-App:**
- Run `python tracex/manage.py runserver` in the root directory of TracEX _(Using e.g. Terminal)_

**Command-Line Tool:**
- Run `python command_line_tool.py` in the root directory of TracEX _(Using e.g. Terminal)_

### Pre-Commit

- If you intend on expanding the code, please run `pre-commit install` in the root directory of TracEX _(Using e.g. Terminal)_



## Set Up Guide

### Download
Expand Down

0 comments on commit c0838e9

Please sign in to comment.