Studius — a portmanteau of "study" and "us" — is a web application that aims to streamline the matching process between students and tutors online. Currently the project employs a number of technologies including PostgreSQL, Express.js, React, and Node.js.
The following steps detail how to setup the development environment for the web application.
Clone this repository,
$ git clone https://github.com/MinErn-Chen/Studius.git
$ cd studius
and install the necessary dependencies for both server and client,
$ cd server
$ yarn install
$ cd ../client
$ yarn install
Log in to PostgreSQL locally and run all commands in /server/database.sql, sequentially. Try out the sample user input command to confirm creation of the database and users table.
Edit the user credentials in /server/db.js to match that of the local PostgreSQL account. Host, port and database should most likely be kept the same.
Run yarn start in both /server and /client to boot up server and client (duh). Confirm connection to client via http://localhost:4000/ in a modern web browser.