Five Line Rhyme

Five Line Rhyme is a full stack web app full of poems only 5 lines long.

Link to project: https://five-line-rhyme.up.railway.app/

• Five Line Rhyme
  • How It's Made:
  • Optimizations
  • Lessons Learned:
  • Installation
  • Usage
  • Dependencies
  • Dev Dependencies

How It's Made:

Front end: HTML, CSS, Bootstrap, JavaScript

Back end: Node, Express, Pug, MongoDB, Mongoose, Cloudinary

Users can look at poems shared by others or create an account to post their own.

Optimizations

• I would like to add
  • pagination
  • profile pages
  • indicator for how many lines and characters there are while writing a poem
  • update poem button

Lessons Learned:

• I learned how to
  • extend pug layouts and use mixins and partials to make my code more readable and maintainable
  • validate unique user names and emails
  • update existing user's profiles
  • populate posts with user information
  • use multer to handle file uploads
  • use cloudinary to crop, store, and destroy images
  • Use GitHub actions to check formatting on each push I ran into some issues with the hosted version working differently than my local version, so now I make sure to check if my data exists before accessing it.

Installation

You can install the necessary dependencies with

npm install

Then create a file in the config folder called ".env" and add the following variables

MONGODB_URI
SESSION_SECRET
CLOUD_NAME
API_KEY
API_SECRET
CLOUDINARY_URL

Usage

Use npm run start to run the app normally and npm run dev to run the app in development mode

Dependencies

"@fortawesome/fontawesome-free": "^6.1.1",
"@ladjs/bootstrap-social": "^7.0.2",
"@node-rs/bcrypt": "^1.6.0",
"axios": "^0.27.2",
"body-parser": "^1.19.2",
"bootstrap": "^5.1.3",
"cloudinary": "^1.31.0",
"compression": "^1.7.4",
"connect-mongo": "^4.6.0",
"dotenv": "^16.0.0",
"errorhandler": "^1.5.1",
"express": "^4.17.3",
"express-flash": "^0.0.2",
"express-session": "^1.17.2",
"lusca": "^1.7.0",
"mailchecker": "^4.1.14",
"moment": "^2.29.1",
"mongoose": "^6.2.8",
"morgan": "^1.10.0",
"multer": "^1.4.4",
"node-sass": "^7.0.1",
"node-sass-middleware": "^1.0.1",
"nodemailer": "^6.7.3",
"nodemailer-sendgrid": "^1.0.3",
"passport": "^0.5.2",
"passport-local": "^1.0.0",
"passport-oauth2-refresh": "^2.1.0",
"popper.js": "^1.16.1",
"pug": "^3.0.2",
"validator": "^13.7.0"

Dev Dependencies

"chai": "^4.3.6",
"eslint": "^8.12.0",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-plugin-chai-friendly": "^0.7.2",
"eslint-plugin-import": "^2.25.4",
"mocha": "^9.2.2",
"mongodb-memory-server": "^8.4.1",
"nodemon": "^2.0.19",
"nyc": "^15.1.0",
"sinon": "^13.0.1",
"supertest": "^6.2.2"