Skip to content
This repository has been archived by the owner on Mar 2, 2025. It is now read-only.

Commit

Permalink
Add database info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
@robiworks
robiworks committed Dec 31, 2021
1 parent 4541a98 commit fbd88f1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ The backend currently supports 3 API calls, all of them are `GET` methods and re
- `/apartments`: returns apartments only.
- `/houses`: returns houses only.

### Database initialisation

The database is initialised with a `init.sql` file/script copied over to the `/docker-entrypoint-initdb.d/` directory inside the database image. The official PostgreSQL Docker image will run `.sql` scripts found in that directory. The script creates all the tables that I planned out for the database and fills them with data.

## Possible improvements & additions

As this is just a prototype of the application a lot more could be added to the final product. Here are just a few that came to my mind:
Expand Down

0 comments on commit fbd88f1

Please sign in to comment.