Skip to content

Commit 862e3ef

Browse files
committed
Improve readme
1 parent b83335a commit 862e3ef

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

README.md

+23-11
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,46 @@
1-
# Realtime
1+
# Realtime
22

33
[![Build Status](https://travis-ci.org/CodeYellowBV/realtime.svg?branch=master)](https://travis-ci.org/CodeYellowBV/realtime)
44
[![codecov](https://codecov.io/gh/CodeYellowBV/realtime/branch/master/graph/badge.svg)](https://codecov.io/gh/CodeYellowBV/realtime)
55

66
Realtime is a time tracking tool made from scratch for the needs of Code Yellow employees.
77

8-
It is a work in progress.
8+
At Code Yellow we want to track time with few steps, and see what others are working on / have been working on. Toggl got close, but we don't want to rely on external services. This is why we built our own Open Source variant.
99

10-
At Code Yellow we want to track time with few steps, and see what others are working on / have been working on. Toggl got close, but we don't want to rely on external services. We <3 open source.
10+
TODO: fancy gif
1111

1212
## Requirements
1313

14-
```
15-
apt-get install python3 python-virtualenv
16-
```
14+
For the frontend:
15+
16+
- Node v6+
17+
- npm v3+ or Yarn
18+
19+
For the backend:
1720

18-
- Node v4+
19-
- npm v2+
21+
- Python 3 (`apt-get install python3`)
22+
- Python virtualenv (`apt-get install python-virtualenv`)
23+
- Postgresql
24+
25+
The backend should work on Linux and Mac, but not Windows. For installation details with Debian, checkout the `scripts/` folder in our [Vagrant repository](https://github.com/CodeYellowBV/realtime-vagrant).
2026

2127
## Install
2228

2329
```
30+
cd frontend && yarn
31+
```
32+
33+
```
34+
cd backend
35+
virtualenv --python=python3 venv
2436
source venv/bin/activate
2537
pip install -r packages.pip
26-
python manage.py db upgrade
38+
./manage.py db upgrade
2739
```
2840

2941
## Running
3042

3143
### Development
3244

33-
1. `cd frontend; npm start`
34-
1. `cd backend; source/venv/bin/activate; python manage.py runserver`
45+
1. `cd frontend; yarn start`
46+
1. `cd backend; source/venv/bin/activate; ./manage.py runserver`

0 commit comments

Comments
 (0)