Skip to content
Guryash edited this page Jun 14, 2024 · 11 revisions

Technology

Tech used

  • Postgres
  • Docker
  • Clerk
  • React
  • Node JS
  • Stripe JS
  • Express
  • TailwindCSS

Installation and Set-up Guide

Installation

We need to install a few programs before we can get started. Here are the links to all the programs required:

  • Node JS - click yes if it asks you to install
  • Docker - To run the containerised database
  • Git
  • GitHub Desktop - recommended but not required
  • VS Code - recommended IDE
  • If you have PGAdmin installed, it can cause problems, troubleshooting information bellow
  1. Install all required programs
  2. Open a terminal and navigate to where you would like to save the files, using the command cd "{directory where you want to save the files}"
  3. Clone the repository using git clone https://github.com/UoaWDCC/auis-portal.git
  4. Navigate to correct directory by typing cd auis-portal

For TailwindCSS, on VS Code install the extension TailwindCSS Intellisense

Deployment

For our project, we have our deployment set up in three environments. The first one is developer, this is the main one you will be using, it is hosted locally. The second one is a production developer environment, this is hosted on a server and you can access it with a website link. This is able to be seen by everyone but it is not the production release, this gets updated every time main branch is updated. The third environment is production, this will be updated manually at every milestone and it is open to everyone. You don't need to worry about the details for this, if you need further clarification, please contact the tech lead. In summary, you just need to worry about your own local development environment.

Clone this wiki locally