Welcome to the SRC monorepo 👋
The Shared Recruiting Company, SRC (pronounced "source"), is an open source, candidate-centric recruiting platform. SRC promotes two-way, opt-in communication between candidates and companies. 🤝
For candidates, SRC is a recruiting AI assistant that lives in your inbox. No more recruiting spam emails vying for your attention. SRC manages your inbound job opportunities when you aren't looking for a new role and supercharges your job search once you are.
For companies, SRC stops you from wasting time sourcing candidates that aren't actively looking for a new role. SRC integrates into your existing recruiting stack and automatically re-engages interested candidates once they are ready for a new role.
Right now, SRC is invite only. If you are interesting in joining, sign up at sharedrecruiting.co.
For user-facing app documentation, checkout the SRC Docs.
For code-related documentation, all the documentation lives in this repository. Read the directory-level README, read the code comments, or read the code itself 🤓
The SRC web app (sharedrecruiting.co) built via Sveltekit + Tailwind + Supabase and deployed with Vercel
First setup your local environment variables. From the /web directory, run
cp .env.example .env.local
# Now edit .env.local and replace the values to match your local setup
# Use whichever editor you prefer (I use vim)
vi .env.localTo start the web app, run
npm run dev -- --open To run a local instance of Supabase, run
supabase startIf you want to log into the app locally, add your Google OAuth client ID/secret to the bottom of web/supabase/config.toml:
[auth.external.google]
enabled = true
client_id = "xxx"
secret = "xxx"Changes to web/supabase/config.toml are ignored by Git, so you don't have to worry about accidentally committing your client secret.
Browser and Typescript and test are written via Playwright and Vitest. You can run them with,
npm run testDatabase tests are powered by pgtap and allow us to test complex database logic, like RLS policies and triggers. The tests live in web/supabase/tests/database. You can run them with
supabase test dbNote: The web/ is under active development. Test coverage is intentionally low until the app stabilizes.
The SRC Google Cloud Functions. The cloud functions are responsible for managing and reacting to user emails. To minimize unnecessary dependencies, each cloud function is an independent, deployable go module.
Shared go libraries
Scripts for common manual tasks
SRC is open source to empower candidates and companies to contribute and collaborate on building an ideal and efficient recruiting experience for all.
Have a feature idea? Create an issue. Want to fix a bug? Create a pull request. Have a question? Start a discussion.
We want to build the best candidates experience possible. To do so, SRC needs examples of all types of inbound recruiting emails. If you have inbound recruiting emails you want to contribute to our dataset please forward them to examples@sharedrecruiting.co
Auto-generated code documentation to make the repository easier to navigate and contribute to.
Last Updated: 2023-05-15
The root directory is for managing the high-level documentation and configuration files of the Shared Recruiting Co. (SRC) platform. It includes files for managing contributions, code of conduct, security, and Git tracking. Additionally, it includes directories for managing Cloud Functions, deployment, shared libraries, scripts, and the web application.
This file contains a list of files and directories that should be ignored by Git when tracking changes in the codebase. The listed files and directories include environment files and macOS-specific files.
This file contains the SRC Code of Conduct, which outlines the expected behavior of community members and contributors, and the consequences for violating those expectations. It includes a pledge to make participation in the community a harassment-free experience for everyone and examples of acceptable and unacceptable behavior. Community leaders are responsible for enforcing these standards.
This file is a comprehensive guide for contributing to the SRC project. It includes instructions on forking the repository, making changes locally, creating and solving issues, creating a pull request, and enabling maintainer edits. It also congratulates contributors on their merged PR and mentions that their contributions will be deployed in the next release.
This file contains the security policy for SRC. It outlines the currently supported version and provides instructions for reporting a vulnerability.
This file contains the configuration settings for SRC's security analysis tool and language used in the platform. It includes options for specifying the namespace, output format, working directory, target files, and findings to analyze. The default language is English, but it can be changed to Spanish by modifying the "language" field in this YAML file. Additionally, the file provides a link to the complete list of findings that can be analyzed.
The .github directory is for managing various aspects of the SRC codebase on GitHub. It includes a FUNDING.yml file for listing supported funding platforms, a dependabot.yml file for configuring Dependabot, a pull request template, and directories for issue templates and workflows. These files and directories help streamline contributions, automate tasks, and ensure code quality.
The cloudfunctions directory is for various Cloud Functions that handle different tasks related to the Shared Recruiting Co. platform. These tasks include syncing candidate and recruiter emails, handling changes to Gmail labels, processing and labeling recruiting emails, and handling Gmail push notifications. Each subdirectory contains implementation files, test functions, configuration files, and module dependencies.
The deploy directory is for deploying the Shared Recruiting Co. platform to Google Cloud Platform using Pulumi and Go code. It includes configuration files for Pulumi and GolangCI, Go code for creating and deploying various Google Cloud Functions, and files for managing dependencies and testing.
The libs directory is for managing the configuration and source code of the Shared Recruiting Co. platform. It includes packages for interacting with the SRC database, Gmail API, and machine learning functionality related to recruiting emails and job postings. Additionally, it includes a directory for implementing the pub/sub system in the SRC platform.
The scripts directory is for storing scripts related to the development and maintenance of the SRC codebase. This includes a script called update-go-mods.sh which updates the dependencies of several Go packages in the cloudfunctions directory and runs tests.
The web directory is for managing the web application of the SRC (Shared Recruiting Co.) platform. It includes configuration files for ESLint, Prettier, PostCSS, TypeScript, and Vite. It also contains the src directory for managing the source code, the static directory for storing static assets, the supabase directory for managing the Supabase project configuration, and the tests directory for storing Playwright tests. Additionally, it includes a README.md file with instructions for creating, developing, and building a Svelte project.