This project provides a register/login functionality with authentication calls.

As a user you can like and unlike other users, you can also see user information based on their id, or even see who are the users with the most likes.

.env file has been pushed to the code for easier testing purposes otherwise it would be skipped

Please import the postman collection (Social-Club-API.postman_collection) in your Postman App to use all the API Endpoints and Postman environment variables(request payloads,token,etc).

When you login, in the response you should get an auth_token, replace that value with the token variable in the Social-Club Postman Environment to use the other API-s which require a valid token.

Local Environment Setup

Requirements and setup:

MongoDB installation is optional. If local MongoDB is running, make sure to update the .env file with the appropriate MONGO_URL.

npm i
npm run docker-mongo   `if no local MongoDB is installed`
npm run ts-node-server

Development Environment with Docker Setup (Both Server and DB)

$ npm run docker-build
$ npm run docker

Run Test in Dev environment (while docker is running)

npm i
npm run test

Why MongoDB?

MongoDB is used to store all the data. There are 2 tables (users and user_likes).

In the users table(collection) we are storing the user information including the hashed password.

In the user_likes table we are storing all the actions(in our case all the likes) that users invoke upon each other. Everytime a user likes another user , we add an entry in user_likes table with their corresponding id-s. Everytime a user unlikes another user, we remove the entry from the table. Based on this flow, we can easily find the number of likes by just counting the entries of that user(id) in the user_likes table.

Since we know the access-points that are going to be used by the API-s, all the calls are done on the _id or on the indexed field email, so we are achieving O (1) complexity.