Skip to content

Latest commit

 

History

History
624 lines (460 loc) · 10.8 KB

README.md

File metadata and controls

624 lines (460 loc) · 10.8 KB
Raw

kdGG

Course

Programming 5

Created by

Database

Run the following commands to set up the database:

docker build -t "kdgg_db_image:Dockerfile" .
docker create --name kdgg_db_container -p 5433:5432 kdgg_db_image:Dockerfile
docker container start kdgg_db_container

How to run

  • dev: ./gradlew bootRun --args='--spring.profiles.active=dev'
  • prod: ./gradlew bootRun --args='--spring.profiles.active=prod

Open here

How to test

./gradlew test - automatically loads the test profile as well

Domain

The domain describes a typical chat application. It is based on the following entities:

  • User
  • Channel
  • Post

Users can be members of many channels. A channel can have many members. A post is always associated with a channel. A post is associated with a user and the channel in which the post was created.

Week 1

Channel API

Getting all channels

200 OK
GET http://localhost:8081/api/channels

Response

[
  {
    "channelID": 1,
    "name": "DuckiesGang",
    "description": "The coolest gang in town, no spaghett allowed!"
  },
  {
    "channelID": 2,
    "name": "ACS",
    "description": "Applied Computer Science at KdG"
  }
]
204 No Content
GET http://localhost:8081/api/channels

Response

[]

Getting a channel by ID

200 OK
GET http://localhost:8081/api/channels/1

Response

{
  "channelID": 1,
  "name": "DuckiesGang",
  "description": "The coolest gang in town, no spaghett allowed!"
}
404 Not Found
GET http://localhost:8081/api/channels/300

Getting a channels users

200 OK
GET http://localhost:8081/api/channels/1/users

Response

[
  {
    "userID": 1,
    "name": "Peter",
    "birthdate": "1992-11-19",
    "role": "Admin"
  }
]
204 No Content
GET http://localhost:8081/api/channels/3/users

Response

[]
404 Not Found
GET http://localhost:8081/api/channels/300/users

Delete a channel by ID

204 No Content
DELETE http://localhost:8081/api/channels/1
404 Not Found
DELETE http://localhost:8081/api/channels/3

User API

Getting all users

200 OK
GET http://localhost:8081/api/users

Response

[
  {
    "userID": 1,
    "name": "Peter",
    "birthdate": "1992-11-19",
    "role": "Admin"
  },
  {
    "userID": 2,
    "name": "Seif",
    "birthdate": "2003-10-12",
    "role": "Mod"
  },
  {
    "userID": 3,
    "name": "Filip",
    "birthdate": "2001-06-15",
    "role": "Mod"
  },
  {
    "userID": 4,
    "name": "Elina",
    "birthdate": "2003-04-15",
    "role": "User"
  }
]
204 No Content
GET http://localhost:8081/api/users

Response

[]

Getting a user by ID

200 OK
GET http://localhost:8081/api/users/1

Response

{
  "userID": 1,
  "name": "Peter",
  "birthdate": "1992-11-19",
  "role": "Admin"
}
404 Not Found
GET http://localhost:8081/api/users/500

Getting a users channels

200 OK
GET http://localhost:8081/api/users/1/channels

Response

[
  {
    "channelID": 1,
    "name": "DuckiesGang",
    "description": "The coolest gang in town, no spaghett allowed!"
  }
]
204 No Content
GET http://localhost:8081/api/users/2/channels

Response

[]
404 Not Found
GET http://localhost:8081/api/users/500/channels

Delete a user by ID

204 No Content
DELETE http://localhost:8081/api/users/1
404 Not Found
DELETE http://localhost:8081/api/users/500

Week 2

Patch a channel by ID

200 OK
PATCH http://localhost:8081/api/channels/1
Content-Type: application/json
Accept: application/json

{
  "description": "This description changed!"
}

Response

{
  "channelID": 1,
  "name": "DuckiesGang",
  "description": "This description changed!"
}
404 Not Found
PATCH http://localhost:8081/api/channels/3
Content-Type: application/json
Accept: application/json

{
  "description": "This channel does not exist!"
}

§

Update a user by ID

200 OK
PUT http://localhost:8081/api/users/1
Content-Type: application/json
Accept: application/json

{
  "name": "new name",
  "birthdate": "2000-01-01",
  "role": "Mod"
}

Response

{
  "userID": 1,
  "name": "new name",
  "birthdate": "2000-01-01",
  "role": "Mod"
}
404 Not Found
PUT http://localhost:8081/api/users/500
Content-Type: application/json
Accept: application/json

{
  "name": "new name",
  "birthdate": "2000-01-01",
  "role": "Mod"
}

Post a message to a channel

201 Created
POST http://localhost:8081/api/channels/1/posts
Content-Type: application/json
Accept: application/json

{
  "content": "This is a message!"
}

Response

{
  "postID": 6,
  "content": "This is a message!",
  "username": "Peter",
  "userID": 1,
  "upVotes": 0,
  "postedAt": "2023-03-05T13:23:03.467354"
}
404 Not Found
POST http://localhost:8081/api/channels/300/posts
Content-Type: application/json
Accept: application/json

{
  "content": "This channel doesn't exist!"
}

Patch update the upvote count of a post

200 OK
PATCH http://localhost:8081/api/posts/1
Content-Type: application/json
Accept: application/json

{
  "upVotes": 1000
}

Response

{
  "postID": 1,
  "content": "The first post by Peter in DuckiesGang",
  "username": null,
  "userID": 1,
  "upVotes": 1000,
  "postedAt": "2022-12-09T18:58:18.639"
}
404 Not Found
PATCH http://localhost:8081/api/posts/500
Content-Type: application/json
Accept: application/json

{
  "upVotes": 1000
}

Getting all users in XML

GET http://localhost:8081/api/users
Accept: application/xml

Response

<List>
    <item>
        <userID>1</userID>
        <name>Peter</name>
        <birthdate>1992-11-19</birthdate>
        <role>Admin</role>
    </item>
    <item>
        <userID>2</userID>
        <name>Seif</name>
        <birthdate>2003-10-12</birthdate>
        <role>Mod</role>
    </item>
    <item>
        <userID>3</userID>
        <name>Filip</name>
        <birthdate>2001-06-15</birthdate>
        <role>Mod</role>
    </item>
    <item>
        <userID>4</userID>
        <name>Elina</name>
        <birthdate>2003-04-15</birthdate>
        <role>User</role>
    </item>
</List>

Getting all channels in JSON

GET http://localhost:8081/api/channels
Accept: application/json

Response

[
  {
    "channelID": 1,
    "name": "DuckiesGang",
    "description": "The coolest gang in town, no spaghett allowed!"
  },
  {
    "channelID": 2,
    "name": "ACS",
    "description": "Applied Computer Science at KdG"
  }
]

Week 3

Users being seeded:

  • Peter
  • Seif
  • Filip
  • Elina

Passwords for all users are: password

Hidden information on the homepage (http://localhost:8081/): You can only see posts of users when you're logged in.

Week 4

To test endpoints easier, put your JSESSIONID and XSRF-TOKEN in this file http-client.env.json and make sure the http file is using the dev environment (top of the window: Run with:).

Users:

  • Peter (Admin)
  • Seif (Mod)
  • Filip (Mod)
  • Elina (User)

Passwords for all users are: password

Overview of the roles and their permissions:
  • Users can not delete channels or posts.
  • Only Admins can create new channels and delete them.
  • Mods and Admins can delete posts.

Week 5

New profile

  • test

Week 7

Code Coverage

Coverage Report

Mocking tests

verify tests

Role verification tests

Week 9

No new, build instructions, the ones on top still apply.

Bootstrap icon

Download icon in the download buttons on the Users and Channels page.

  • Users: Users
  • Channels: Channels

Custom form validation (using zod)

Interesting to see:

Here i define the schema for the objects I use in this project and also infer the types from the schemas.

This allows me to only have to change the schema and the types will be updated automatically.

Zod also allows me to parse the data from the server and validate it against the schema which returns me a parsed object that is now fully typesafe!

Additional Dependencies

Extra

🚀✨TYPESCRIPT✨🚀

Week 12

CSV file to upload: channels.csv