README.md

Hanwoollim Application Server

한양대학교 밴드동아리 한울림에서 진행한 동아리멤버 전용 앱 개발 프로젝트입니다.

Stack

Application Data and tools

• JavaScript

• Node.js

  • ExpressJs

  • Sequelize

  • Jsonwebtoken

  • BcryptJs

  • Dotenv

  • Cookie-parser

• MySQL

• Amazon EC2

• Amazon RDS

• NGINX

DevOps • Business Tools

• GitHub

• VisualStudio Code

• Slack

• Notion

APIs

• User-App API

  • https://app.swaggerhub.com/apis/Jaemani/Hanwoolim-Server-User/1.0.0

• Manager-App API

  • https://app.swaggerhub.com/apis/Jaemani/Hanwoolim-Server-Manager/1.0.0

Some important things to know

• These applications are only made for students in the music club "Hanwoollim" of Hanyang University.

• Although there are two applications 'User-app' and 'Manager-app', but both operated and controlled by one server.

  • and those are sharing same user-information table.

• sign in & sign up

  • User must be signed in to access home of applications.

  • If you're new to this applications, you could sign up to make new account and then sign in.

    • sign up is only allowed in 'User-app'

    • Because of we couldn't certificate student's information through University-Database, we don't know if the student ID you type is match with other informations. If we found you have signed up with the student ID which is not yours, or typed the fake student ID, your account would be deleted.

    • If you have signed up with wrong student ID, Please update your student ID to correct number in 'Option' - 'Edit Information' at 'User-app'

    

• You are not possible to access the page when you 'just signed up'

  If everything is okay, the chairman of the Hanwoollim would approve you soon.

  

Main Functions

User-app

• Initial Screen

  • sign in

  • sign up

    

• Main Screen

  You will see the Gear icon at the top-right corner. You are able to check or update your personal information through this.

  And you could see preview of 'Announcement', 'Reservations of tody', 'personal Reservation' and 'Lightning gathering of today' in the middle.

  Also "Home", "Lightning gathering", "Reservatoin", "Board" at the bottom.

  

• Personal Information Setting (The Gear icon)

  • Edit information

  • Withdrawal

    You could Edit your personal information or Withdrawal here.

    

  • Edit information

    This is a page for entering the information you want to update.

    

• Announcement

  Only Manager and Chairman could create and edit announcement.

  Announcement is about what you need to know as a Member of Hanwoollim.

  

• Lightning Gathering

  We didn't make this function yet

• Reservation

  You would see the date and time that other people already reserved.

  You could choose other time to reserve practice room (maximum time is 1 hour and you can only have one Personal-practicing-reservation in a day).

  

• Board

  This is the data-sharing board. All of the member could share useful data, file, study-guide(or anything) here.

  

  • For make sharing

    • You must set the file-expired date.

    • File-upload is an optional.

    

Manager-app

• Initial Screen

  • sign in

    

• Main screen

  For Manager (집행기)

  • 'Reservation' and 'Announcement' are available

  For Chairman (관리자)

  • 'Manage member', 'Reservaion', 'Announcement' and 'Approve new member' are available

  

• Manage member

  Chairman would get the list of all members, and able to change position or force expel member

  

• Reservation

  It is very similar to reservation function on User-app, but this function is to reserve Team-practicing and Mentoring

  

  In addition, you have to insert Team(for Team-practicing) or Name(for Mentoring)

  

• Announcement

  As mentioned above, Announcement is about what members need to know as a Member of Hanwoollim.

  

• Approve new member

  Once the new member is signed up, information of member would added in the list. Chairman could check and approve the new members.

  

About errors

You would never get client-side error if you have wrote as right format.

The basic format of information follows below:

• ID: string

• PW: string

• name: string

• major: string

• student ID : 10 digits number

You should fill all of the text box when you're signing up

If you got any other problems, please contact developer.