DevSoc Jobsboard

Connecting UNSW CSE students with top employers since 2018

Visit Jobs Board • About • Team • Installation • Documentation

DevSoc is the UNSW Software Development Society. We do not represent the School, Faculty, or University. This website seeks to be a centralised platform for students looking for employment opportunities, but its information has not been officially endorsed by the University, Faculty, School, or the Computer Science and Engineering Society. You should confirm with the employer that any information received through this website is correct.

About

Jobs Board is the go-to place for CSE students to find student jobs and internships. DevSoc partners with a wide range of top employers to provide you with only the best opportunities to enhance your student experience.

Visit Jobs Board to find out more. If you're curious about our workflow and how we make all of this possible, feel free to look through our Jira and Confluence workspaces. If there's a missing feature you would like to see, please submit a suggestion through this form or even better, contribute to the project yourself by opening an issue and making a pull request.

Team

Jobs Board was made with 🤍 by CSE students, for CSE students. Jobsboard is a team that is part of DevSoc Projects! See TEAM.md for more details on the teams that contributed to the development of Jobsboard!

Installation

Prerequisites

• Git
• Nodejs and yarn
• Docker
• PostgreSQL
• (Recommended) Database IDE like DataGrip (Free for students)

Setting Up

1. Clone the jobs-board repo.

   git clone https://github.com/devsoc-unsw/jobsboard.git
   

2. Download Docker Desktop

3. Set up the neccessary environment variables

   • Frontend (optional): Create a .env.local file in the frontend directory with the following contents:

      NEXT_PUBLIC_API_BASE_URL=http://localhost:8080/
     

     The environment variable NEXT_PUBLIC_API_BASE_URL is used as the base URL for any API requests made by the frontend. If you have the backend running locally, it should use the your local backend instead (http://localhost:8080/). If the backend is not running locally or if NEXT_PUBLIC_API_BASE_URL is not provided, https://jobsboard.staging.csesoc.unsw.edu.au/api will be used as the base URL as a fallback option.

   • Backend: Create a .env file in the backend directory with the following contents:

      NODE_ENV=development
      SERVER_PORT=8080
      DB_HOST=localhost
      DB_PORT=5432
      DB_USER=postgres
      DB_PASSWORD=mysecretpassword
      DB_NAME=postgres
      MAIL_USERNAME=test@gmail.com
      MAIL_PASSWORD=password
      MAIL_SMTP_SERVER=smtp.gmail.com
      MAIL_SMTP_SERVER_PORT=465
     

     If having DB_HOST=localhost result in errors such as ECONREFUSED, change it to DB_HOST=db.

4. Navigate to the frontend and backend directories and install the required dependencies by running yarn

Running the frontend locally

1. Start up the frontend by navigating to the frontend directory and running yarn dev

2. Go to localhost:3000 on your browser to see the frontend running locally!

Running the backend locally

Without Docker

1. After installing PostgreSQL on your computer, open a terminal and run psql. Now, you should see a command prompt that may look like this matthewliu=#.
2. Create a new database called postgres by running create database postgres; In the future, you can log straight into this database by running psql -U postgres in your terminal.
3. Navigate to the backend directory and run yarn serve to start up the server.

With Docker

1. After installing Docker on your computer, open a terminal and run docker compose build to build all the containers required for Jobsboard. In the future, you will only need to run either docker compose build api or docker compose build test as you make changes to them.
2. Start up the database by running docker compose up -d db in your terminal.
3. Start up the server by running docker compose up -d api in your terminal.

Refer to the Using Docker section below if you need more assistance.

Go to localhost:8080 on your browser to see the backend running locally!

API Documentation After the server is started, you can access the API documentation at localhost:8080/docs. When adding, modifying or removing routes from backend/src/index.ts, please remember to update the documentation at backend/src/docs/openapi.json accordingly to by following the existing format.

Running the backend in production mode

Only use this section if you are working on a function that needs the mail queue initialised. This assumes that you are using Gmail as the test account when trying to send emails.

1. Ensure that your 2-FA for Gmail is enabled.

2. Generate an App Password by following this (Focus on the “Create & Use App Passwords” section).

3. Navigate to the docker-compose.yml file and add this in under the api environment:

NODE_ENV=production
SERVER_PORT=8080
JOBS_BOARD_API_URL=http://127.0.0.1:8080
MAIL_SMTP_SERVER=smtp.gmail.com
MAIL_SMTP_SERVER_PORT=465
MAIL_USERNAME=<REPLACE WITH YOUR EMAIL ADDRESS>
MAIL_PASSWORD=<REPLACE WITH YOUR APP PASSWORD FROM STEP 2>

4. For the frontend, ensure you set the environment variable in frontend/.env to use http://localhost:8080/

5. Navigate to mail.ts and modify the secure field in the transportOptions object config to true as shown below:

const transportOptions = {
  host: process.env.MAIL_SMTP_SERVER,
  port: parseInt(process.env.MAIL_SMTP_SERVER_PORT, 10),
  secure: true, // SET THIS TO TRUE
  auth: {
    user: process.env.MAIL_USERNAME,
    pass: process.env.MAIL_PASSWORD,
  },
  requireTLS: true,
};

Using Docker

1. Navigate to the root of the project.
2. Run docker compose build to build all containers or docker compose build [container-name] for a specific container specified in the compose file.
3. Run docker compose up to start all containers or docker compose up [container-name] for starting a specific container specified in the compose file.

   To view which containers you would like to build/start, refer to docker-compose.yml

Running tests

Frontend

We do not have tests yet... :(

Backend

Without Docker

1. Go to backend/tests/config.js and set apiUrl to http://localhost:8080. If this is your first time, run git update-index --skip-worktree tests/config.js to prevent git from tracking this file in the future.

2. Navigate to the backend directory and run the following commands in your terminal

   yarn serve
   yarn test
   

With Docker Navigate to the root directory and run the following commands in your terminal

docker compose build api
docker compose build test
docker compose up test

Make sure to stop the server and db before rerunning the tests either using the the Docker Desktop GUI or by running docker stop jobsboard-api-1 and docker stop jobsboard-db-1 in your terminal.

Use the logs in the terminal or the Docker Desktop GUI to check your tests.

The reason Docker is used when testing is because we're given a guarantee that the conditions are exactly the same every time and because it emulates what the behaviour will be on prod running in the container - where there are differences.

Code Style & Linting

Frontend

Coming

Backend

• Run yarn run lint to see both style and linting issues in .ts files within the backend directory at once
• Run yarn run lint:fix to automatically amend all style and linting issues that would be identified by running the first command (recommended)
• Run yarn run format to see all style issues in .ts files within the backend directory according to the prettier configuration file .prettierrc
• Run yarn run format:fix to automatically amend all the style issues identified by running npm run prettier (recommended)

Finished your work

Always double check before submitting your pr

1. Run docker compose build api and docker compose build test and ensure the builds complete successfully
2. Run docker compose up test and ensure all tests pass

Pushing

Log in to your preferred container registry via command line and run docker-compose push, ensure that they've finished pushing and then deploy where required.