/QuoteMaker

This is a progressive web application that helps registered users to log in and check their daily quotes which would be an inspiration to start their day. This application would also have flexibility where users would be able to check 10 quotes per day which would motivate them to complete their work on time, they also have the flexibility to modify the quote which displays on the screen and they can delete the quote if they do not like it.This app would be inspirational to complete things on time

Primary LanguageJavaScript

QuoteMaker

This is a progressive web application that helps registered users to log in and check their daily quotes which would be an inspiration to start their day. This application would also have flexibility where users would be able to check 10 quotes per day which would motivate them to complete their work on time, they also have the flexibility to modify the quote which displays on the screen and they can delete the quote if they do not like it.This app would be inspirational to complete things on time.

Codacy analysis

Codacy Badge

SonarCloud

SonarCloud

Snyk:

image

Team Members

drawing       Tejaswi

Priyanka Maruthi            Tejaswi Avula

Summary of Proposal Stack

Below are the details for stack:

  • Backend language + framework : The backend language & framework for this project would be JavaScript / Node.js

  • Backend app host : The backend app host would be Heroku

  • DataBase : The Database for this project would be Atlas MongoDB

  • Frontend Design : The Front end design would be with React js

  • Static analysis tools : The static analysis tools used for this project is Snyk.

Link to the wiki pages

Project Wiki

Links related to project:

Documentation Site:

Test Cases sample project:

Heroku hosted links:

Swagger:

Steps for Compilation/Build/Test/Run:

For Backend:

  • We have intialized by using this command : npm init
  • Installed Express : npm i express
  • Installed dotenv : npm i dotenv
  • created dot env and added the part
  • installed nodemon
  • To start the server we have used : npm start (running in localhost : 5000)

For Frontend:

  • Created the react app : npx create-react-app frontend
  • Installed Bootstrap : npm i react-bootstrap
  • Installed React-Redux : npm install react-redux
  • Installed react-router-dom : npm i react-router-dom
  • Installed axios : npm i axios
  • To start the server we have used : npm start (running in localhost : 3000)

Build:

  • we have builded this project and deployed it through Heroku

How to run tests:

  • We have used Mocha as a testing framework for node.js and we have followed the below steps to run the tests.

    • we created the directory named test with the command : mkdir test
    • we created the basic test file named "basicTest.js"
    • we have used the command "npx mocha basicTest.js" to run the tests.

  • We tried implementing test cases for our project but all the testcases were failing due to some reason so we have implemented testcases on sample node with express project and generated the test report : https://maruthi158.github.io/TestingSampleProject/

For Code Documentation:

We are trying to implementing code documentation by using JSDoc for node.js but we are facing the issues.

Links related to project: