Skip to content

dimi-fn/pidz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nojudgies.com

Made by Zeiadork, ImmanuelEgboche, PaulNKD, and dimi-fn.

The project is deployed at: https://no-judgies.netlify.app/

Contents


Project Description

Nojudgies.com is an online safe space for people to laugh, rant, be human, comment, react and communicate anonymously and without judgment.

Who is it for?

Anyone who wants to post whatever they want, anonymously, without fear of judgemenet (within reason). Have a laugh, rant, complain and not be judged.

Website Functionality

  • Users are able to visit the website and anonymously post journal entries.
  • Users are able to visit the website and anonymously post journal entries.
  • Users can write up to 350 characters per journal entry.
  • Users are able to choose gifs from giphy in their posts and comments
    • they are able to choose between four gifs per post or comment.
  • Users are able to view other peoples' entries.
  • Users are able to react to other peoples’ entries via three emojis
  • Users are able to comment on other people’s entries.

Installation & Usage

Installation

  • Clone or download the repo.
  • Open terminal and navigate to the server directory.
  • Run npm install to install dependencies.

Server

  • Open terminal and navigate to the server directory.

  • Initialize an npm package: npm init -y

  • Install express: npm install express

  • Install body-parser to be able to request the body: npm install body-parser

  • Install jest for testing: npm install jest --save-dev

  • Install supertest for testing: npm install supertest --save-dev

  • Install cors: npm install cors --save

  • Optionally install nodemon to update changes from server without having to re-launch the server when changes are taken place: npm install nodemon --save-dev

  • Update the package.json file as followed:

      "scripts": {
          "start": "node server.js",
          "test": "jest --watch --silent",
          "coverage": "jest --coverage",
          "dev": "nodemon server.js"
    
  • Run the server: npm run dev

  • To test the files of the server run: npm run test, or npm run coverage to also get the percent of the degree to which the source code of the program is executed when running the respective tests.


Client

  • To run the tests: navigate to the client directory and run: npm init -y, npm install jest --save-dev
    • then run: npm run test or npm run coverage to get the test results

Technologies

  • HTML/CSS, JavaScript

Process

  • Created an initial design of the website at https://wireframe.cc/, and more designs at https://excalidraw.com/ for the front-end
  • Set up the server with a models and controllers directory, and got the server running
  • Created test scripts for testing the server-side
  • Set up the client side
  • Created test scripts for testing the client-side


Licence

MIT license