Skip to content

Commit

Permalink
update readme (#65)
Browse files Browse the repository at this point in the history
* update readme

* update readme again
  • Loading branch information
maribsta authored Aug 2, 2024
1 parent 26a634a commit bf4300c
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Norgestur-backend
This backend was developed from scratch during a hackathon by [@Daniel](https://github.com/Daniel-Jansson), [@Kenneth](https://github.com/kennetng) and [@Artur](https://github.com/apkrauze).
Welcome to the Norgestur project! This is the 3rd version of the game, developed by summer interns in 2024. This game aims to provide an engaging and fun way to explore public transportation in Norway. Below you will find information on how to set up, run, and contribute to the project. This is the backend of our project and works together with [entur-game-frontend](https://github.com/entur/entur-game-frontend).

## Developers
### 2024 Summer Team
- [Magnus](https://github.com/Magnus-Farstad)
- [Marianne](https://github.com/maribsta)
- [Oscar](https://github.com/oscarahalvorsen)
- [Selma](https://github.com/selmagudmundsen)
- [Tomas](https://github.com/tomaswedege)

### Previous Developers
- [Artur](https://github.com/apkrauze)
- [Kenneth](https://github.com/kennetng)
- [Daniel](https://github.com/Daniel-Jansson)

This project will receive a players game stats from [entur-game-frontend](https://github.com/entur/entur-game-frontend).
To run this project you need do have docker and run the script in the script tag.

## Application scripts

### Docker
To run this project you need do have docker and run the script in the script tag.
Note that if changes are made to the script below for either database name or postgres_password you also need to enter application-local and change the values for the respective fields.
```
docker run --name norgestur-db -p 5432:5432 -e POSTGRES_DB=norgestur-db -e POSTGRES_PASSWORD=entur123 -d postgres:15.2-alpine
Expand Down

0 comments on commit bf4300c

Please sign in to comment.