List of features

Feature 1: Ask questions This feature allows user to ask a question on the website which will be displayed on the questions page.

Feature 2: provide answers This feature allows user to answer a question which will be displayed on the answers page of the question.

Feature 3: Search for posts. This feature allows user to search for a post based on a text, title and tag of the question.

Feature 4: Tag posts. This feature has the total number of questions of a particular tag which is displayed on the tags page of the webiste.

Feature 5: Authenticate registered users. This feature is authentication of a user. This feature allows registering and logging in a user. This feature also checks if the credentials during login are valid or not.

Feature 6: Comment on questions and answers. This feature allows users to post comments on a question or an answer.

Additional Features.

Sorting of the Questions: The Questions are sorted based on the newest question, active question, unanswered questions, Also they are sorted based on number of comments and number of views.

For each feature indicate the test

• Feature 1: Ask questions - testing\cypress\e2e\addQuestion.cy.js

• Feature 2: provide answers - testing\cypress\e2e\newAnswer.cy.js

• Feature 3: Search for posts - testing\cypress\e2e\search.cy.js

• Feature 4: Tag posts - testing\cypress\e2e\tags.cy.js

• Feature 5: Authenticate registered users - testing\cypress\e2e\login.cy.js

• Feature 6: Comment on questions and answers - testing\cypress\e2e\comment.cy.js

Additional Features:

-Sorting : testing\cypress\e2e\sorting.cy.js (contains views and comments)

For each server endpoint indicate the test

NOTE : Please run the tests one file after the other for example run answer.test.js then run login.test.js This will pass all tests otherwise some tests will fail due to server.

• /addAnswer : server\tests\newAnswer.test.js

• /getAnswerById/:qid : server\tests\answer.test.js

• /login : server\tests\login.test.js

• /register : server\tests\register.test.js

• /addComment : server\tests\newComment.test.js => (describe("POST /addComment))

• /addCommentOnAnswer : server\tests\newComment.test.js => (describe("POST /addCommentOnAnswer"))

• /getQuestion : server\tests\question.test.js

• /getQuestionById/:qid : server\tests\question.test.js

• /getQuestionByIdComment/:qid : server\tests\question2.test.js

• /addQuestion : server\tests\newQuestion.test.js

• /getTagsWithQuestionNumber : server\tests\tags.test.js

Additional Feature:

• server\tests\question.test.js => (line number 212 & 224)

Instructions to generate and view coverage report

cd server npx jest --coverage

here note that there will be tests that will fail here they are not actually failing but due to functions running asynchronously and the tests are for errors also that is why they will fail otherwise the tests are passing.

Instructions for e2e tests

If while running the e2e tests there is a time where no data can be seen in the screen, please destroy the database and restart the server and run that tests again. This happens because of the limiter function which does not validate many login requests from that user.

Instructions for jest tests

Do not run the test files at once, please run the jest files one after the another. There are error testing which will not allow to pass tests if run all files at once.

Also as the database error test is tested in the answer.test.js it will fail one test at 1st time but rerun it and it will pass. This is due to error testing test.

If user wants to run file locally.

if user wanto to run the project locally the will need to change the MONGO URL in the config.js file.

And the user needs to also add the packages npm install
jsonwebtoken morgan bcrypt dotenv js-cookie express-rate-limit

config.js => Change to 'mongodb://localhost:27017/fake_so'

Intruction to run file through docker

When the user starts the program please go to terminal of the server image and run "node destroy.js" and then run "node init.js". This will ensure that all the functions and tests are running as defined.

Login Credentials

email : user1@example.com
password : password