Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
janis-schanbacher authored Sep 25, 2020
1 parent d32d30a commit 4961072
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
Teamtable is a project management web application made for the web development course at HTW Berlin by [Janis Schanbacher](https://github.com/janis-schanbacher) and [Florian Wolf](https://github.com/flo-wolf).
This repository is the [Ruby on Rails](https://rubyonrails.org/) backend, which provides a RESTful API. The React frontend can be found [here](https://github.com/https://github.com/teamtable/teamtable) and tested at: [teamtable.io](http://teamtable.io).


## Features
The following functionalities are implemented in the API
- User registration, e-mail confirmation, password reset
- Token authentication (using devise, devise-jwt), authorization
- Projects, lists, cards and tags
- Memberships and assignments
- Multilanguage


## Getting started

### Prerequisites
Expand Down Expand Up @@ -47,15 +57,6 @@ This repository is the [Ruby on Rails](https://rubyonrails.org/) backend, which
```


## Features
The following functionalities are implemented in the API
- User registration, e-mail confirmation, passwod reset
- Token authentication (using devise, devise-jwt), authorization
- Projects, lists, cards and tags
- Memberships and assignments
- Multilanguage


## Usage
To use the application locally run `$ rails server -p 3001` and use the following request base URL: `http://localhost:3001`

Expand Down

0 comments on commit 4961072

Please sign in to comment.