README.md

EffiMatch

A platform to connect referrers and job-seekers.
View Demo · View Design · Report Bug · Request Feature

frontend build:

backend build:

Note that we are only making our frontend open-source due to security reasons. If you want the access to our backend code, please contact the tech lead.

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Build
  • Other Scripts
• Maintainence
  • Manage Member Information
  • Update Timeline
  • Update Project Readmes
  • Update Department Readmes
  • Sync Newletters
• Roadmap
• Contributing
• License
• Contact
• Important Links

About The Project

EffiMatch is a platform to facilitate job referring process for both job-seekers and referrals.

The users of our platform can log in as either referrer or job-seeker, and they can switch role whenever they want to.

Referrers are full-time employees who are willing to share the refer opportunities to apply for their companies. By sharing the refer opportunities, the referrers could potentially earn reward from their companies by successfully refer someone.

Job-seekers are people applying for jobs. They can search for refer opportunities to their target companies on the platform.

Built With

• Front-end

  • React
  • TypeScript
  • Ant Design
  • Misc
    • Redux
    • React Router
    • Craco
    • Eslint
    • Prettier
    • Axios
    • ts-codegen
    • ClearBit logo API
    • less

• Back-end

  • Springboot
    • Spring Data JPA
    • Spring Security
    • Redis
  • MySQL
    • MyBatis
    • Flyway
  • AWS
    • S3

• CI/CD

  • Jenkins

Getting Started

Prerequisites

• yarn

# macOS
$ brew install yarn

# Windows
$ choco install yarn

# CentOS / Fedora / RHEL
$ curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo

Installation

1. Clone the repo

If you are in our GitHub repo:

$ git clone https://github.com/ucsdtriplec/effimatch.git

If you are in our GitLab repo:

$ git clone https://gitlab.com/ucsd-triple-c/referral-frontend.git

2. Install NPM packages

# install dependencies
$ yarn

3. Start the app

• local environment

# serve with hot reload at localhost:3000
$ yarn start:local

• dev environment

# serve with hot reload at localhost:3000
$ yarn start:dev

Build

• local environment

# build with local environment
$ yarn build:local

• dev environment

# build with dev environment
$ yarn build:dev

Other Scripts

# generate api client using ts-codegen
$ yarn api

# check style before committing
$ yarn pre-commit

Maintainence

The repository on GitHub is a mirror of our development repository on GitLab. You can view code and submit issues here. If you want to join the active development team, please contact the tech lead.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the GPL-3 license.

This means that you may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

Contact

Dekun Ma (Tech Lead) - [email protected]

Important Links

GitLab Repository Links (for EffiMatch team internal developers):

• frontend repo
• backend repo
• mailer service repo

Atlassian Links (for EffiMatch team internal members):

• Jira
• Confluence