Getting Started with the Project

Before we jump into this, you need to be aware that due to sensitive information currently present in some of the files, this repository will be kept private for the moment. This may change soon pending discussion.

Step 1: Cloning Repository

Clone the repository into your local machine either via HTTPS or SSH using the command

git clone https://github.com/csesoc/jobs-board.git (HTTPS) or

git clone git@github.com:csesoc/jobs-board.git (SSH)

Open

Step 2: Building code using Docker

After navigating into the repository, please take some time to familiarise yourself with the code. Once that’s all good, you can explore and play around with the frontend by first building the project with Docker. If you aren’t familiar with Docker, please have a read through this Using Docker (and more!). For those of you who aren’t familiar with TypeScript, https://devsoc.atlassian.net/wiki/pages/createpage.action?spaceKey=N&title=TypeScript%20Cheatsheet.

To get started:

1. Ensure you have docker installed on your local machine and it is currently running. If you don’t have it installed, you can download it here Docker Desktop: The #1 Containerization Tool for Developers | Docker and create and account (don’t worry, it’s free )

2. Once Docker is up and running, return to your terminal and in the root of the repository, run docker-compose up. NOTE: This step might take a while (a couple of minutes) to build as the codebase is quite large.

3. You should now see your terminal starting to build the relevant docker images and will look something like this

   Open

   

   You should be able to see the line jobs-board_test_1 exited with code 1 at the end. This means that the project has been built and you can confirm that and start-up the frontend by checking the Docker application

   Open

   

However, if you happen to see this message instead

Open

This means that you did not start the Docker application so it did not build successfully. Try checking and make sure everything is good before proceeding.

Step 3: Working with the Frontend

Start up the frontend either by launching it directly from the Docker application or the Docker VSCode extension and have a play around with it, it should launch on port 8081

Open

Now that everything is up and running, you are now able to start coding . Have fun and try not to break anything .

Step 4: Seeing Changes Made to Code

If you have made a change to the code and want to see how it looks on the frontend, you might have noticed that when running docker-compose up doesn’t reload your changes. This is normal – don’t panic. Just add the --build flag to the end and you should be good. So just run docker-compose up --build. This tells Docker to rebuild the project based on the changes you made. Again, this process might take some time.

Step 5: Pushing Code

Once you are satisfied, with the code that you’ve written, go ahead and push it to the appropriate branch and make a new pull request. When doing this step, please take note of the following:

1. Ensure that your commit message corresponds to the relevant Jira ticket.

2. Ensure that your commit message appropriately describes what you did.

3. When making a merge request, please set at least 1 project lead to review your code in addition to any team members. Do not merge without a project lead’s approval. This is to prevent any headaches in the future .

4. Notify the relevant people in Discord about your pull request.

Before Our First Meeting

Ensure that you are able to get the code up and running. Hopefully this document was useful in guiding you through the necessary steps but please ask a project lead if you are having trouble with any of it.

After Our First Meeting

Look up guides to any tools/tech stack you are unfamiliar with. The leads will try to help you as best as we can but it’s ultimately up to you have a willingness to learn these.