Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 1.81 KB

README.md

File metadata and controls

35 lines (27 loc) · 1.81 KB
Raw

Jobsika

JobSika is a website that allows people to anonymously rate their companies and share their salaries, in order to create a more level playing field between employers and employees. People can contribute their salary information to the website and help to change the current narrative around salary information.

HOW TO CONTRIBUTE TO JobSika

First you will need to run the application locally and install dependancies.

To run the application locally, you should:

  1. Fork the project from the GitHub repository. To do this, click the "Fork" button in the top-right corner of the repository page and follow the instructions.
  2. Install the required dependencies:
  • Golang version 1.16 and above
  • GNU make
  • docker with docker-compose
  • swagger

Here is the detail steps you can take to install the required dependencies:

  • Jump to the ./backend folder: cd ./backend
  • Run the database: make start-postgres
  • Run the api: make run
  • Build and run: make run && ./jobsika
  • Build and run with docker: make docker-build && make docker-run
  • Serve the api documentation: make serve-swagger
  • Run the api with the DB: make start-api

Others docs to check

How to create a new table: how-to-add-a-new-table.md

  • Jump to the ./frontend folder: cd ./frontend
  • Install the dependencies: npm install or yarn install
  • Run the app: npm run dev or yarn dev
  • Now that the application is running, you can access it through http://localhost:3000/

Aaaand that's it! Thank you for taking the time to read this document. Following the steps outlined in this document will help you set up and run the application locally. We hope this document has been helpful and that it makes it easier for you to contribute and help make jobsika better.