How angelac123/twitter-api-2020 works
Project type and purpose
• This is a Node.js/Express “backend-only” Web API implementing a mini-Twitter clone.
• It exposes REST endpoints for tweets, replies, likes, followships, user-profile management, and an admin interface.
• It uses Sequelize + MySQL for persistence, Passport for authentication (JWT + Local), Multer for file-upload, Imgur for media storage, and includes migrations, seeders, and automated tests.
File structure
• Top-level:
• app.js – entry point, sets up Express, middleware, routes
• config/ – database credentials (config.json), Passport strategies
• controllers/ – MVC “C”—admin-controller.js, tweet-controller.js, user-controller.js
• routes/ – Express routers organized by module
• models/ – Sequelize models + index.js wiring models to DB
• migrations/ & seeders/ – Sequelize CLI DB schema + initial data
• middleware/ – auth (Passport JWT), multer (file upload), error handler
• helpers/ – file-helpers, general utility functions
• test/ – Mocha/Chai unit & request specs
• Patterns: classic MVC + layered service → controller → model. DB migrations/seeders separate.
README for insights
• Features outline domain entities (User, Tweet, Reply, Like, Followship) and interactions.
• Tech stack: Node.js, Express, MySQL2, Sequelize, Passport, JWT, Multer, Imgur, Mocha/Chai.
Essential details to capture
• Authentication flows: login via Local → JWT issue → subsequent requests use JWT middleware
• File-upload flow: client sends image → Multer handles local upload → helper uploads to Imgur → store Imgur link in DB
• Database schema relationships:
• User 1–* Tweet
• Tweet 1–* Reply
• User *–* Tweet through Like
• User *–* User through Followship