jackytsheng / campus-backend

🧳 Third project from Jiangren. Backend

🏆 Awarded 2nd Place in JR ACADEMY Full-stack Bootcamp 10th Commercial Project Competition.

Website link

JR Academy Project 3 - Campus system 1.0

This is the backend project three from JR Academy. Objective of this project is to deliver a learning management system for an educational institution

What's new?

Added AWS based email function Users will receive email upon registration and change password

Content

• Introduction
• What's new
• About
  • Backeend Feature Summary
  • Tech Stack
  • Database Structure
• Run this program locally
  • Required programs
  • Spring Boot Configuration
  • Database Configuration(connect to Docker Hub)
  • Swagger UI
• Future Improvement

About

This is project three from JR Academy We are team RMR101. Objective of the project is to deliver a learning management system for an educational institution.

Backend Feature Summary

• Secure log-in with encrypted password and JWT authentication
• AWS document upload and download for handing assignments

Tech stack:

Framework:

• Spring Boot
• Maven

Testing:

• Junit
• Mockito

Security:

• JSON Web Token

Clouds:

• AWS S3 & Presigned URL
• AWS SDK
• AWS Simple Email Service

CI/CD:

• Java CI with Maven
• Docker/ Docker Hub

Development:

• Agile (Scrumn)
• Github flow
• Swagger UI

Database Structure

Run this program locally

Required programs

• JAVA version 14 download
• Docker download
• IntelliJ IDEA (Recommended) or preferred editor

Spring Boot Configuration

• Git Clone or download master code to your local drive
• Unzip and open downloaded file in IntelliJ IDEA or your preferred editor
• Start the main application in
  src/main/java/com.rmr101.campus/CampusApplication.java

Database Configuration(connect to Docker Hub)

• pull pre-packed mysql image from command line (Docker login required):

  docker pull nkanyang/mysql:admin

• Start docker image:

  docker run -itd --name mysql-campus -p 3306:3306 -e MYSQL_CAMPUS_PASSWORD=123456 nkanyang/mysql:campus-admin

• login container

  docker exec -it mysql-test bash

• login mysql

  mysql -u root -p

  input password:

  123456

  use campus

  select * from user;

  it should display a campus_id as "admin", now we can log in as admin with password: admin

Swagger UI

• Step1: Start application

• Step2: Access URL http://localhost:8080/swagger-ui.html in your browser

Future Improvement

Feature

• generate a password reset email to users upon reset password request
• allow multiple teachers to teach one course
• pagination in search results
• add JWT function in SWAGGER UI for easier feature development

Tech

• add a long expiry JWT to keep users' login status
• add load balancer
• move from http to https