a3-randy-huang

.env

@@ -0,0 +1,5 @@
+MONGO_URI="mongodb+srv://admin:[email protected]/?retryWrites=true&w=majority"
+GITHUB_CLIENT_ID="91b158ab67ad0d5c4c82"
+GITHUB_CLIENT_SECRET="aa6e7a2c5e323d36fb05fb07ab574cfab40b669d"
+BASE_URL="http://localhost:3000"
+SESSION_SECRET="secret"

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+package-lock.json

README.md

@@ -1,114 +1,28 @@
 Assignment 3 - Persistence: Two-tier Web Application with Database, Express server, and CSS template
 ===
+## Blogging App
 
-Due: September 25nd, by 11:59 AM.
+Glitch: http://a3-randy-huang.glitch.me
 
-This assignnment continues where we left off, extending it to use the most popular Node.js server framework (express), 
-a database (mongodb), and a CSS application framework / template of your choice (Boostrap, Material Design, Semantic UI, Pure etc.)
+My app is a blog that allows users to create posts and update them, along with reading times for each post. I faced some challenges with setting up the Tailwind configuration, but I was able to get it working. I used GitHub Strategy because it was required in the technical achievement. I used Tailwind because I liked the look of it and utility classes. I used my previous CSS as a base and then added Tailwind on top of it. I also used Axios for HTTP requests.
 
-Baseline Requirements
----
-
-Your application is required to implement the following functionalities:
-
-- a `Server`, created using Express (no alternatives will be accepted for this assignment)
-- a `Results` functionality which shows all data associated with a logged in user (except passwords)
-- a `Form/Entry` functionality which allows users to add, modify, and delete data items (must be all three!) associated with their user name / account. 
-- Persistent data storage in between server sessions using [mongodb](https://www.mongodb.com/cloud/atlas) (you *must* use mongodb for this assignment). You can use either the [official mongodb node.js library](https://www.npmjs.com/package/mongodb) or use the [Mongoose library](https://www.npmjs.com/package/mongoose), which enables you to define formal schemas for your database. Please be aware that the course staff cannot provide in-depth support for use of Mongoose.  
-- Use of a [CSS framework or template](https://github.com/troxler/awesome-css-frameworks). 
-This should do the bulk of your styling/CSS for you and be appropriate to your application. 
-For example, don't use [NES.css](https://nostalgic-css.github.io/NES.css/) (which is awesome!) unless you're creating a game or some type of retro 80s site.
-
-Your application is required to demonstrate the use of the following concepts:  
-
-HTML:  
-- HTML input tags and form fields of various flavors (`<textarea>`, `<input>`, checkboxes, radio buttons etc.)
-- HTML that can display all data *for a particular authenticated user*. Note that this is different from the last assignnment, which required the display of all data in memory on the server.
-
-Note that it might make sense to have two pages for this assignment, one that handles login / authentication, and one that contains the rest of your application.
-For example, when visiting the home page for the assignment, users could be presented with a login form. After submitting the login form, if the login is 
-successful, they are taken to the main application. If they fail, they are sent back to the login to try again. For this assignment, it is acceptable to simply create 
-new user accounts upon login if none exist, however, you must alert your users to this fact.  
-
-CSS:  
-- CSS styling should primarily be provided by your chosen template/framework. 
-Oftentimes a great deal of care has been put into designing CSS templates; 
-don't override their stylesheets unless you are extremely confident in your graphic design capabilities. 
-The idea is to use CSS templates that give you a professional looking design aesthetic without requiring you to be a graphic designer yourself.
-
-JavaScript:  
-- At minimum, a small amount of front-end JavaScript to get / fetch data from the server. 
-See the [previous assignment](https://github.com/cs-4241-23/shortstack) for reference.
-
-Node.js:  
-- A server using Express and a persistent database (mongodb).
-
-General:  
-- Your site should achieve at least 90% on the `Performance`, `Best Practices`, `Accessibility`, and `SEO` tests 
-using Google [Lighthouse](https://developers.google.com/web/tools/lighthouse) (don't worry about the PWA test, and don't worry about scores for mobile devices).
-Test early and often so that fixing problems doesn't lead to suffering at the end of the assignment. 
-
-Deliverables
----
-
-Do the following to complete this assignment:
-
-1. Implement your project with the above requirements. I'd begin by converting your A2 assignment. First, change the server to use express. Then, modify the server to use mongodb instead of storing data locally. Last but not least, implement user accounts and login. User accounts and login is often the hardest part of this assignment, so budget your time accordingly.
-2. If you developed your project locally, deploy your project to Glitch (unless completing the alternative server technical acheivement described below), and fill in the appropriate fields in your package.json file.
-3. Test your project to make sure that when someone goes to your main page on Glitch (or an alternative server), it displays correctly.
-4. Ensure that your project has the proper naming scheme `a3-yourfirstname-yourlastname` so we can find it.
-5. Fork this repository and modify the README to the specifications below.
-6. Create and submit a Pull Request to the original repo. Name the pull request using the following template: `a3-firstname-lastname`.
-
-Acheivements
----
-
-Below are suggested technical and design achievements. You can use these to help boost your grade up to an A and customize the 
-assignment to your personal interests, for a maximum twenty additional points and a maximum grade of a 100%. 
-These are recommended acheivements, but feel free to create/implement your own... just make sure you thoroughly describe what you did in your README, 
-why it was challenging, and how many points you think the achievement should be worth. 
-ALL ACHIEVEMENTS MUST BE DESCRIBED IN YOUR README IN ORDER TO GET CREDIT FOR THEM.
-
-*Technical*
-- (10 points) Implement OAuth authentication, perhaps with a library like [passport.js](http://www.passportjs.org/). 
-*You must either use Github authenticaion or provide a username/password to access a dummy account*. 
-Course staff cannot be expected, for example, to have a personal Facebook, Google, or Twitter account to use when grading this assignment. 
-Please contact the course staff if you have any questions about this. THIS IS THE HARDEST ACHEIVEMENT OFFERED IN WEBWARE. You have been warned!  
-- (5 points) Instead of Glitch, host your site on a different service like [Heroku](https://www.heroku.com) or [Digital Ocean](https://www.digitalocean.com). Make sure to describe this a bit in your README. What was better about using the service you chose as compared to Glitch? What (if anything) was worse? 
-- (5 points) Get 100% (not 98%, not 99%, but 100%) in all four lighthouse tests required for this assignment.  
-
-*Design/UX*
-- (10 points) Make your site accessible using the [resources and hints available from the W3C](https://www.w3.org/WAI/), Implement/follow twelve tips from their [tips for writing](https://www.w3.org/WAI/tips/writing/), [tips for designing](https://www.w3.org/WAI/tips/designing/), and [tips for development](https://www.w3.org/WAI/tips/developing/). *Note that all twelve must require active work on your part*. 
-For example, even though your page will most likely not have a captcha, you don't get this as one of your twelve tips to follow because you're effectively 
-getting it "for free" without having to actively change anything about your site. 
-Contact the course staff if you have any questions about what qualifies and doesn't qualify in this regard. 
-List each tip that you followed and describe what you did to follow it in your site.
-- (5 points) Describe how your site uses the CRAP principles in the Non-Designer's Design Book readings. 
-Which element received the most emphasis (contrast) on each page? 
-How did you use proximity to organize the visual information on your page? 
-What design elements (colors, fonts, layouts, etc.) did you use repeatedly throughout your site? 
-How did you use alignment to organize information and/or increase contrast for particular elements. 
-Write a paragraph of at least 125 words *for each of four principles* (four paragraphs, 500 words in total). 
-
-Sample Readme (delete the above when you're ready to submit, and modify the below so with your links and descriptions)
----
-
-## Your Web Application Title
-
-your glitch (or alternative server) link e.g. http://a3-charlie-roberts.glitch.me
-
-Include a very brief summary of your project here. Images are encouraged, along with concise, high-level text. Be sure to include:
-
-- the goal of the application
-- challenges you faced in realizing the application
-- what authentication strategy you chose to use and why (choosing one because it seemed the easiest to implement is perfectly acceptable)
-- what CSS framework you used and why
-  - include any modifications to the CSS framework you made via custom CSS you authored
-- the five Express middleware packages you used and a short (one sentence) summary of what each one does. If you use a custom function for *one* (and one alone) middleware please 
-add a little more detail about what it does.
+Express middleware packages:
+- express-session: This package allows me to use sessions in my app.
+- passport: This package allows me to use passport.js for authentication.
+- mongoose: This package allows me to use MongoDB in my app.
+- passport-github: This package allows me to use the GitHub strategy for authentication.
+- ensureAuthenticated: This is a custom middleware function that I wrote to ensure that a user is authenticated before they can access certain pages, and otherwise redirects them to the login page.
 
 ## Technical Achievements
-- **Tech Achievement 1**: I used OAuth authentication via the GitHub strategy
+- OAuth authentication via GitHub: I used passport.js and the GitHub strategy to implement OAuth authentication. I faced challenges regarding configuring the different routes, but got it working.
+- Lighthouse: The site scores 100% on all four lighthouse tests (performance, accessibility, best practices, SEO).
 
 ### Design/Evaluation Achievements
-- **Design Achievement 1**: I followed the following tips from the W3C Web Accessibility Initiative...
+- **Accessibility**: I followed the following tips from the W3C Web Accessibility Initiative:
+- Make link text meaningful: I made sure that all of my links have meaningful text, such as "Login with Github" instead of just "Login".
+- Provide informative page titles: The page titles are informative and describe the page, which includes 'Blogging App' to describe the app.
+- Ensure that interactive elements are easy to identify: The logout link is highlighted during mouse hover.
+- Create designs for different viewport sizes: I used Tailwind's responsive breakpoints to make the site responsive, modifying margin sizes for mobile devices.
+- Write code that adapts to the user’s technology: I used Tailwind's responsive breakpoints to make the site responsive.
+- Ensure that all interactive elements are keyboard accessible: Added aria labels to buttons like submit, as well as roles for the form elements.
+

app.js

@@ -0,0 +1,114 @@
+const express = require('express');
+const mongoose = require('mongoose');
+const passport = require('passport');
+const GitHubStrategy = require('passport-github').Strategy;
+const session = require('express-session');
+const app = express();
+const port = 3000;
+require('dotenv').config();
+
+const User = require('./src/models/User');
+
+// Connect to MongoDB
+mongoose.connect(process.env.MONGO_URI, {
+    useNewUrlParser: true,
+    useUnifiedTopology: true,
+});
+
+// Configure Passport
+passport.use(new GitHubStrategy({
+    clientID: process.env.GITHUB_CLIENT_ID,
+    clientSecret: process.env.GITHUB_CLIENT_SECRET,
+    callbackURL: `${process.env.BASE_URL}/auth/github/callback`, 
+},
+    async (accessToken, refreshToken, profile, done) => {
+        try {
+            // Check if the user already exists in the database
+            let user = await User.findOne({ githubId: profile.id });
+
+            if (!user) {
+                user = new User({
+                    githubId: profile.id,
+                    username: profile.username,
+                });
+
+                await user.save();
+            }
+
+            return done(null, user);
+        } catch (err) {
+            return done(err);
+        }
+    }
+));
+
+passport.serializeUser((user, done) => {
+    done(null, user);
+});
+passport.deserializeUser((user, done) => {
+    done(null, user);
+});
+
+app.use(session({
+    secret: process.env.SESSION_SECRET,
+    resave: false,
+    saveUninitialized: true,
+}));
+
+app.use(passport.initialize());
+app.use(passport.session());
+
+app.use(express.json()); // Parse JSON request bodies
+app.use(express.static('src/public'));
+
+const blogPostRoutes = require('./src/routes/blogRoutes');
+
+app.get('/', (req, res) => {
+    if (req.isAuthenticated()) {
+        res.redirect('/blogs');
+    } else {
+        res.redirect('/login');
+    }
+})
+
+app.get('/login', (req, res) => {
+    if (req.isAuthenticated()) {
+        res.redirect('/blogs');
+    } else {
+        res.sendFile(__dirname + '/src/public/login.html');
+    }
+})
+
+app.get('/logout', (req, res) => {
+    req.logout(function (err) {
+        if (err) { return next(err); }
+        res.redirect('/login');
+    });
+});
+
+app.get('/blogs', ensureAuthenticated, (req, res) => {
+    res.sendFile(__dirname + '/src/public/blog.html');
+});
+
+app.use('/api/blogs', blogPostRoutes);
+
+app.get('/auth/github',
+    passport.authenticate('github'));
+
+app.get('/auth/github/callback',
+    passport.authenticate('github', { failureRedirect: '/' }),
+    (req, res) => {
+        res.redirect('/blogs');
+    });
+
+function ensureAuthenticated(req, res, next) {
+    if (req.isAuthenticated()) {
+        return next();
+    }
+    res.redirect('/'); // Redirect to the login page
+}
+
+
+app.listen(port, () => {
+    console.log(`Server is running on port ${port}`);
+});

package.json

@@ -0,0 +1,39 @@
+{
+    "name": "a3-blog",
+    "version": "1.0.0",
+    "description": "blog app for a3",
+    "author": "huangrandy",
+    "engines": {
+        "node": "20.6.0",
+        "npp": "9.8.1"
+    },
+    "scripts": {
+        "start": "node app.js",
+        "build-css": "tailwindcss build -i src/public/styles.css -o src/public/output.css --watch"
+    },
+    "dependencies": {
+        "autoprefixer": "^10.4.15",
+        "axios": "^1.5.0",
+        "build": "^0.1.4",
+        "dotenv": "^16.3.1",
+        "express": "^4.18.2",
+        "express-session": "^1.17.3",
+        "mongoose": "^7.5.2",
+        "nodemon": "^3.0.1",
+        "passport": "^0.6.0",
+        "passport-github": "^1.1.0",
+        "passport-local": "^1.0.0",
+        "passport-local-mongoose": "^8.0.0",
+        "tailwind": "^4.0.0",
+        "tailwindcss": "^3.3.3"
+    },
+    "jest": {
+        "moduleNameMapper": {
+            "axios": "axios/dist/node/axios.cjs"
+        }
+    },
+    "devDependencies": {
+        "postcss": "^8.4.30",
+        "postcss-cli": "^10.1.0"
+    }
+}

src/controllers/blogController.js

@@ -0,0 +1,63 @@
+const BlogPost = require('../models/BlogPost');
+
+// Controller functions
+exports.getAllBlogPosts = async (req, res) => {
+    try {
+        const blogPosts = await BlogPost.find({ githubId: req.user.githubId });
+        res.status(200).json(blogPosts);
+    } catch (error) {
+        res.status(500).send('Internal Server Error');
+    }
+};
+
+exports.createBlogPost = async (req, res) => {
+    const blogPostData = req.body;
+    blogPostData.readingTime = calculateReadingTime(blogPostData.content);
+    blogPostData.githubId = req.user.githubId;
+
+    try {
+        const newBlogPost = new BlogPost(blogPostData);
+        await newBlogPost.save();
+        res.status(200).send('Blog post created successfully');
+    } catch (error) {
+        res.status(500).send('Internal Server Error');
+    }
+};
+
+exports.updateBlogPost = async (req, res) => {
+    const postId = req.params.id;
+    const updatedBlogPostData = req.body;
+
+    try {
+        const updatedBlogPost = await BlogPost.findByIdAndUpdate(
+            postId,
+            updatedBlogPostData,
+            { new: true }
+        );
+
+        if (updatedBlogPost) {
+            res.status(200).send('Blog post updated successfully');
+        } else {
+            res.status(404).send('Blog post not found');
+        }
+    } catch (error) {
+        res.status(500).send('Internal Server Error');
+    }
+};
+
+exports.deleteBlogPost = async (req, res) => {
+    const postId = req.params.id;
+
+    try {
+        await BlogPost.findByIdAndDelete(postId);
+        res.status(200).send(`Blog post id:${postId} deleted successfully`);
+    } catch (error) {
+        res.status(404).send('Blog post not found');
+    }
+};
+
+function calculateReadingTime(content) {
+    const wordsPerMinute = 200;
+    const wordCount = content.split(/\s+/).length;
+    return Math.ceil(wordCount / wordsPerMinute);
+}

src/models/BlogPost.js

@@ -0,0 +1,13 @@
+const mongoose = require('mongoose');
+
+const blogPostSchema = new mongoose.Schema({
+    _id: { type: mongoose.Schema.Types.ObjectId, auto: true, primary: true },
+    githubId: String,
+    title: String,
+    content: String,
+    readingTime: Number,
+});
+
+const BlogPost = mongoose.model('BlogPost', blogPostSchema);
+
+module.exports = BlogPost;

src/models/User.js

@@ -0,0 +1,10 @@
+const mongoose = require('mongoose');
+
+const userSchema = new mongoose.Schema({
+    githubId: String, // Store GitHub user ID
+    username: String, // Store GitHub username
+});
+
+const User = mongoose.model('User', userSchema);
+
+module.exports = User;