Skip to content

skx1322/SyntaxSquad-Repo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 

Repository files navigation

INTRODUCTION

A codenection project teamed with Sin Kai Xing, Venggadanaathan A/L K.Salvam Rishikumaran and Julian Koh;

Track 1 Student Lifestyle

We decided to go for track 1 student lifestyle and decided our project to be about tutor app for student.

Problem Statement

As someone from IT, I think it is best that we should learn thing outside of syallabus from our own as it can teaches you new hard skills that can keep you ahead on everyone. Hence, we wanted to create this project with objective to develop a tutor web app that allow student to attend both pre-recorded or real-time tutor's session from various courses.

Our objective for this app is to promote affordable and personalized courses for student from secondary school, college or university whether it is to learn new skill or to keep up with subject within their syallabus. We also hope to attract people who desired to become tutor to be part of the tutors team as they can tried to gain some experience and learn to improve from students feedback from the course they created.

To ensure students are confident in their tutors, our system will tried to promote tutor that have received great feedback from their previous student and if that's not enough, we also ensure that tutor kept their portfolio transparent to the other students to gain their trust.

Runtime Used

  1. NodeJS (https://nodejs.org/en)
  2. BunSH (https://bun.sh/)

Localhost Development Setup

Local Running Frontend

1: Main Runtime

  • You are required to install NodeJS in order to run the frontend code. Make sure you install the latest one.
https://nodejs.org/en/download

2. Cloning

  • After you have bun.sh installed, you can obtain the git HTTPS and tried to git clone it on a directory/folder you want.
git clone https://github.com/skx1322/Blog_Tech.git

3. Installation for Frontend

  • Head into the "client" folder, you'll start module installation from there. Note that the size of frontend module in development are around 40 MB.
cd client
npm install 

4. Run Frontend's Rendering

  • If installation is completed, you can start running the frontend. Note, the localhost port will be 5173.
npm run dev
  • It'll show localhost:5173 in your local device, go into browser and type "localhost:5173" in the URL search and it'll show you the page.

Local Running Backend

1. Runtime

  • For the backend, we capitalize on the Bun runtime performance and TypeScript integration. First ensure you have Bun installed, ensure to select the right OS and best if latest version.

https://bun.sh/

3. Setup / Installation of Modules

  • To run the server API for local testing, do the following when you're in the server directory
bun i

After modules installed:

bun run dev

Releases

No releases published

Packages

 
 
 

Contributors

Languages