lcnlvrz / opensalary

Open Salary is a free web application created with the objective of recollecting data to make salaries more fair. In this platform you can post a job salary as anonymous and find a salary by occupation, location and currency.

Open Salary

Open Salary is a free web application created with the objective of recollecting data to make salaries more fair. In this platform you can post a job salary as anonymous and find a salary by occupation, location and currency.

Architecture

The Open Salary architecture is based on microservices. This was possible thanks Kong API Gateway, the entrypoint of all services and responsible about authentication (JWT Plugin). Besides, i used the approach zero dependence. That means each service is independent of another one, with their own database.

Frontend

• React with Typescript
• TailwindCSS
• Ant Design

Backend

• NodeJS with Typescript
• NestJS
• PostgreSQL
• Kong API Gateway
• Docker
• Load Balancer

Project Status

This project is currently in production and you can test it clicking the following link:

Open Salary

Instructions

Each service is a nodeJS application, so if you want to up the services:

yarn install

## Create .env file with the followings key
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=postgres
DB_PASSWORD=xxxx
DB_NAME=open-user-service

## For create SSL certificates, use mkcert
SSL=true
SSL_KEY_PATH="./.cert/key.pem"
SSL_CERT_PATH="./.cert/cert.pem"

APP_BASE_URL=https://localhost:9000

JWT_SECRET=testing
JWT_PUBLIC=testing

yarn start:dev

And if you want to up the kong API Gateway:

## Create and .env with the following keys:

USER_SERVICE=https://localhost:8001/user
SALARY_SERVICE=https://localhost:8002/salary

#Frontend application
AWS_CLIENT=https://localhost:9000

JWT_KEY=xxx
JWT_SECRET=xxx

## And then:
docker-compose up -d

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.