Skip to content

Latest commit

 

History

History
396 lines (275 loc) · 11 KB

README.md

File metadata and controls

396 lines (275 loc) · 11 KB
Raw
Football Tactics Hub App Logo

Description

Web app for sharing and discussing football tactics related posts.

Getting Started

Installing Dependencies

Navigate to the /server directory and run:

npm i

then navigate to the /web directory and run:

npm i

Creating the .env file

Navigate to the /server directory, create the .env file and fill the required values, for example:

JWT_SECRET="P3pERrHGia"
JWT_EXPIRES_IN="2 days"

PASSWORD_SALT="OtbO0qbCqE"
PASSWORD_ITERATIONS=11
PASSWORD_KEYLEN=12

Running the server

From within the /server directory, to run the server, execute:

PORT=3001 npm start

Starting the web client

From within the /web directory, to run the web client, execute:

npm start

Server details: (Node.js, TypeScript)

  • Node.js app using Express.js
  • Sqlite3 database

Server endpoints: more details here

GET /api/v1/healthz

  • General:

    • Returns status "OK" as long as the server is up and running.

    • Sample Request :
      curl http://localhost:3001/api/v1/healthz

    • Sample Response :

{
  "status": "OK"
}

POST /api/v1/signin

  • General:

    • Validates user data, signs and sends JWT token to the client.

    • User can use both his/her email and username to signin.

    • Sample Request :
      curl http://localhost:3001/api/v1/signin -X POST -H "Content-Type: application/json" -d '{"login": "michaelehab", "password":"LMfUVfvS(+h(Z#PP}1"}'

    • Sample Response :

{
  "user": {
    "id": "daa2688c36f35962c53e88d54d520c23c18d43e7",
    "email": "[email protected]",
    "firstName": "Michael",
    "lastName": "Ehab",
    "userName": "michaelehab"
  },
  "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkYWEyNjg4YzM2ZjM1OTYyYzUzZTg4ZDU0ZDUyMGMyM2MxOGQ0M2U3IiwiaWF0IjoxNjY3NTg0OTUwLCJleHAiOjE2Njc3NTc3NTB9.iOxOOUf8OuGevVn7W2KmwQ17FiKhddOHTLXyHGKH8d4"
}

POST /api/v1/signup

  • General:

    • Registers a new user to the database.

    • Signs and sends a JWT token to the client.

    • Sample Request :
      curl http://localhost:3001/api/v1/signup -X POST -H "Content-Type: application/json" -d '{"firstName": "Michael", "lastName": "Ehab", "userName": "michaelehab", "email":"[email protected]", "password":"LMfUVfvS(+h(Z#PP}1"}'

    • Sample Response :

{
  "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkYWEyNjg4YzM2ZjM1OTYyYzUzZTg4ZDU0ZDUyMGMyM2MxOGQ0M2U3IiwiaWF0IjoxNjY3NTg0OTUwLCJleHAiOjE2Njc3NTc3NTB9.iOxOOUf8OuGevVn7W2KmwQ17FiKhddOHTLXyHGKH8d4"
}

GET /api/v1/user (Requires Auth)

  • General:

    • Returns the currently signed in user.

    • Sample Request :
      curl http://localhost:3001/api/v1/user -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}"

    • Sample Response :

{
  "user": {
    "id": "daa2688c36f35962c53e88d54d520c23c18d43e7",
    "firstName": "Michael",
    "lastName": "Ehab",
    "userName": "michaelehab",
    "email": "[email protected]"
  }
}

GET /api/v1/user/:id

  • General:

    • Returns a specific user using his/her id.

    • Sample Request :
      curl http://localhost:3001/api/v1/user/daa2688c36f35962c53e88d54d520c23c18d43e7

    • Sample Response :

{
  "user": {
    "id": "daa2688c36f35962c53e88d54d520c23c18d43e7",
    "firstName": "Michael",
    "lastName": "Ehab",
    "userName": "michaelehab",
    "email": "[email protected]"
  }
}

GET /api/v1/profile/:id

  • General:

    • Returns a specific user's profile (same as user but has some stats and recent posts) using his/her id.

    • Sample Request :
      curl http://localhost:3001/api/v1/profile/daa2688c36f35962c53e88d54d520c23c18d43e7

    • Sample Response :

{
  "user": {
    "id": "daa2688c36f35962c53e88d54d520c23c18d43e7",
    "firstName": "Michael",
    "lastName": "Ehab",
    "userName": "michaelehab",
    "email": "[email protected]"
  },
  "recentPosts": [],
  "stats": {
    "numberOfComments": 2,
    "numberOfLikes": 1,
    "numberOfPosts": 0
  }
}

GET /api/v1/posts

  • General:

    • Returns all the posts from the database (no pagination yet).

    • Sample Request :
      curl http://localhost:3001/api/v1/posts

    • Sample Response :

{
  "posts": [
    {
      "id": "3cd7e84f49d9ffe7a55b69becc6e90f06a652b54",
      "title": "Check this Arsenal tiki taka goal",
      "url": "https://www.youtube.com/watch?v=qsPYfQyZZZ0",
      "content": "I really love this goal",
      "userId": "1a35808fd784b53f26d4e8390fd1ec2b4556acb2",
      "postedAt": 1667581704506
    },
    {
      "id": "f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498",
      "title": "Salah's wonderful goal against Man City!",
      "url": "https://www.youtube.com/watch?v=iZ68OskGqow",
      "content": "Check out this great goal, I love how he thought very quickly before dribbling. He was very smart and the coach helped him so much, tell me what you think about it in the comments.",
      "userId": "1a35808fd784b53f26d4e8390fd1ec2b4556acb2",
      "postedAt": 1667581754581
    }
  ]
}

GET /api/v1/posts/:id

  • General:

    • Returns a specific post using the post's id.

    • Sample Request :
      curl http://localhost:3001/api/v1/posts/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498

    • Sample Response :

{
  "post": {
    "id": "f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498",
    "title": "Salah's wonderful goal against Man City!",
    "url": "https://www.youtube.com/watch?v=iZ68OskGqow",
    "content": "Check out this great goal, I love how he thought very quickly before dribbling. He was very smart and the coach helped him so much, tell me what you think about it in the comments.",
    "userId": "1a35808fd784b53f26d4e8390fd1ec2b4556acb2",
    "postedAt": 1667581754581
  }
}

POST /api/v1/posts (Requires Auth)

  • General:

    • Adds a new post to the database.

    • Sample Request :
      curl http://localhost:3001/api/v1/signup -X POST -H "Content-Type: application/json" -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" -d '{"title": "Salah's wonderful goal against Man City!", "url": "https://www.youtube.com/watch?v=iZ68OskGqow"}'

    • Sample Response :

{
  "post": {
    "id": "f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498",
    "title": "Salah's wonderful goal against Man City!",
    "url": "https://www.youtube.com/watch?v=iZ68OskGqow",
    "content": "Check out this great goal, I love how he thought very quickly before dribbling. He was very smart and the coach helped him so much, tell me what you think about it in the comments.",
    "userId": "1a35808fd784b53f26d4e8390fd1ec2b4556acb2",
    "postedAt": 1667581754581
  }
}

DELETE /api/v1/posts/:id (Require Auth)

  • General:

    • Returns a specific post using the post's id, the user sending this request must be the same user who created the post.

    • Sample Request :
      curl http://localhost:3001/api/v1/posts/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498 -X DELETE -H "Accept: application/json"

    • Sample Response : Status code 200 in case of successful deletion.

GET /api/v1/likes/:postId (Require Auth)

  • General:

    • Returns true if the signedIn user has a like on the post using the post's id.

    • Sample Request :
      curl http://localhost:3001/api/v1/likes/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498 -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}"

    • Sample Response :

{
  "exists": true
}

GET /api/v1/likes/count/:postId

  • General:

    • Returns the number of likes on a post using the post's id.

    • Sample Request :
      curl http://localhost:3001/api/v1/likes/count/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498

    • Sample Response :

{
  "likes": 23
}

POST /api/v1/likes/:postId (Require Auth)

  • General:

    • Adds a new like from the signedIn user on the post with postId.

    • Sample Request :
      curl http://localhost:3001/api/v1/likes/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498 -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" -X POST

    • Sample Response : Status code 200 in case of successful like insertion.

DELETE /api/v1/likes/:postId (Require Auth)

  • General:

    • Deletes signedIn user like on the post with postId, the user sending this request must be the same user who added the like.

    • Sample Request :
      curl http://localhost:3001/api/v1/likes/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498 -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" -X DELETE

    • Sample Response : Status code 200 in case of successful like deletion.

GET /api/v1/comments/:postId

  • General:

    • Returns all the comments on post using the post's id.

    • Sample Request :
      curl http://localhost:3001/api/v1/comments/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498

    • Sample Response :

{
  "comments": [
    {
      "id": "3cd7e84f49d9ffe7a55b69becc6e90f06a652b54",
      "userId": "daa2688c36f35962c53e88d54d520c23c18d43e7",
      "postId": "f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498",
      "comment": "What a goal!",
      "postedAt": 1667581754581
    }
  ]
}

GET /api/v1/comments/count/:postId

  • General:

    • Returns the number of comments on a post using the post's id.

    • Sample Request :
      curl http://localhost:3001/api/v1/comments/count/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498

    • Sample Response :

{
  "comments": 15
}

POST /api/v1/comments/:postId (Require Auth)

  • General:

    • Adds a new comment from the signedIn user on the post with postId.

    • Sample Request :
      curl http://localhost:3001/api/v1/comments/f9da75482aa33fd6a2230cc9ff9cc9b8b9a56498 -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" -X POST -d '{"comment": "What a goal!"}'

    • Sample Response : Status code 200 in case of successful comment insertion.

DELETE /api/v1/comments/:id (Require Auth)

  • General:

    • Deletes signedIn user comment using comment's id, the user sending this request must be the same user who added the comment.

    • Sample Request :
      curl http://localhost:3001/api/v1/comments/3cd7e84f49d9ffe7a55b69becc6e90f06a652b54 -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" -X DELETE

    • Sample Response : Status code 200 in case of successful comment deletion.

Client details: (React.js, TypeScript, Chakra UI)

Screenshots:

Home Page User Profile Posts Page View Post Not Found Page Navigation Bar