This is the API with which the Linktr App interacts.
Not needed but recommended: VSCode
This API was designed to work with Linktr App
Use a terminal interface such as bash or zsh, and enter the following:
#download
gh repo clone blarth/linktr-api
#access the folder you downloaded it to
cd linktr-api
#install dependencies
npm iThe app will run locally and you must configure a .env file with a port of your choosing. The default one is 3000.
#you can run the server with
npm run devIn another terminal instance, run the db
#you can start the db with
psqlAuthenticating related routes. Send requests of the respective types with the following:
To signup:
{
email: any email,
password: no restrictions, it will be stored encrypted,
username: name with which the user will be identified,
image: link to an image file, it will be shown as the user's avatar, supported extensions are png, jpg, jpeg, jfif, gif
}
To signin:
{
email: email used to signup,
password: password chosen upon signup
}
The server will respond with a token, to be used on every other route where authetication is required. Use in the headers of your requests as:
{
Authorization: Bearer <GIVEN_TOKEN>
}
To signout, simply send the request with a header containing the Authorization key above.
Send the request with auth header to get info about you, like profile picture and name.
Get timeline route with optional offset parameter, other routes without params.
With the auth header, send the request to timeline to get the ten last posts from users you follow, including their reposts, most recent first, and hashtags, to get the trending hashtags, ten most used first. The optional parameter lets you offset messages to get starting from the n-th last message. To post a link, send request to timeline, as a logged user, with the following:
{
link: the link you want to share,
postText: the text to give it context, you can post hashtags by using # before a word.
}
To follow a user, send the request with the auth and a body with:
{
followedUserId: id of user you want to follow
}
With the auth header, get all users you're following.
Resquests with params:
The request is used to check if user with id <:ID> is your follower.
Send a request with the post id and the current status it has, liked or not. The server will like the post or remove it, adding or removing your user from the list of people who liked it.
Get all posts containing the <:NAME> hashtag (without the #)
Get all posts from user <:NAME>
As a logged user and publisher of the post, send the request to delete it, with the id given.
As a logged user and publisher of the post, you can edit it by sending a request with it's id. Any hashtags removed will lose a score in the trending ranking, any added will gain a score, and remaining ones are unaltered.
Get all likes from post with id <:ID>
Get all posts from user's id <:ID>
As a logged user, with the auth header setting, get the comments from post with <:ID>, info about commentator, such as if it's the original post's author or if it's followed by the logged user is also present. To post, send a request with the auth header shown above and a body with:
{
comment: your comment
}
Send the post request with the auth header and the post's id to mark the post as reposted by you. You follower's will be able to see it if they don't follow the original poster and all comments of the original post are loaded. You'll also increase the repost count of that post.
To check whether it has been reposted or not, send the get request.
Get all users with names starting with <:NAME>, as a logged user, the people you follow being shown up first.
Made with care by
Contact us anytime!