COSC360-G12-Project

Overview

This project is a web blog called Blogaru, allowing users to post, view, and comment on blog posts.

It is created with the following technologies.

• Frontend: Next.js (React)
• Backend: Express (Node.js)
• Database: MariaDB (MySQL)

Getting Started

How to develop

1. Install the latest LTS version of Node.js
2. In both /frontend and /backend, run npm install. This will need to be done whenever another developer has added a new library since you last ran the command. You'll know this by an error message that comes up when you try to follow steps 1 or 2 in 'How to run' below.
3. Install a database client such as HeidiSQL, used to interact with the database directly
   • To access the database, use this info:
     • IP/Port: [redacted]
     • Database: [redacted]
     • Username: [redacted]
     • Password: [redacted]
4. (optional) For writing code, VS Code is recommended.
5. (optional) For testing and developing the API, Postman is recommended.

In general, whenever adding something new, copy the format of existing code if possible.

How to run

1. Frontend - in /frontend, run npm run dev
   • To access the test page with examples of most basics you'll need to create the frontend, visit the address http://localhost:3000/test
2. Backend - in /backend, run node app.js

If an error occurs, see step 2 in 'How to develop'.

Helpful resources

Frontend

React

• For beginners
• Using the state hook
• Other hooks (very nice)
• Next.js blog tutorial

Backend

Sequelize (database connection)

• Data types
• Query functions
• Foreign keys

Database

MariaDB (MySQL)

• MariaDB basics
• Note: Sequelize will automatically create tables in the database, based off of models defined in backend/models/