Skip to content

Commit

Permalink
Updated backend readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RawToast committed Mar 25, 2018
1 parent 0a0ff1d commit e3a5d96
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions dokusho-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,25 @@

[![Build Status](https://travis-matrix-badges.herokuapp.com/repos/RawToast/dokusho/branches/master/2)](https://travis-ci.org/RawToast/dokusho)

Backend server for Dokusho. This is a work in progress and is not currently being used by the frontend.
Throwaway backend server for Dokusho. This is a work in progress service for experimenting and empowering frontend development.

Once the frontend reaches a reasonable level of functionality, this backend service will be revisited.

## Running the backend

### Using sbt

`sbt run` will compile and start a server listening on `8080`

### Docker
### Endpoints

* Fetch the reading history for a user
* GET `/user/<userID>`
* Replace a user's reading history
* PUT `user/<userID>`
* Add a new entry to the user's reading history
* POST `user/<userID>/add`

Currently, no docker configuration has been craeted for this module.

## Additional Information

Expand Down

0 comments on commit e3a5d96

Please sign in to comment.