ibrahimng / stem-portal

A Educational Portal for STEM

STEM Portal Frontend

An interactive online platform which focuses on STEM education, powered by Vue.

Demo here: https://chris-susantooo.github.io/stem-portal/ (NOTE: serve the backend first!)

Demo Limitations

New account registrations may be rejected since only a maximum of 5 user accounts may exist in the current build. Here are some accounts for logging in to try out the restricted features:

• Teacher account:

  Username: teacher1

  Password: TeacherDemo1

• Student account:

  Username: student1

  Password: StudentDemo1

• Parent account:

  Username: parent1

  Password: ParentDemo1

If you wish to create your instance of STEM Portal, which overcomes these limitations, see Installation.

Prerequisites for Installation

You will need the latest Node.js LTS installed on your system.

Yarn is the recommended package manager.

Installation

Clone this repo to your system. In terminal, run:

git clone https://github.com/sca1998/stem-portal.git

... Or download the zipped source code here.

If you are using Visual Studio Code, select Git: clone in the command palette by Ctrl+Shift+P (Windows) or Command+Shift+P (MacOS). Paste in this repo's URL and choose a local folder of your choice.

Navigate to the project root and run:

yarn install

This will install all neccesary dependencies to run STEM Portal.

Project setup

In your project root folder, create a file named .env and put the following code in the file and save:

VUE_APP_API_BASE=http://localhost:8000/api

This tells STEM Portal to send all API requests to this URL.

You should now be ready to serve the project. Type in:

yarn serve

The server will start at port 8080. Open up your browser and visit localhost:8080 to visit the portal!

Customize configuration

See Configuration Reference.