Baldin is a platform that helps you find job opportunities, build and manage your applications, and prepare for interviews.
Documentation is available at https://danphenderson.github.io/baldin/
Source Code: https://https://github.com/danphenderson/baldin
Currently, the application is in its infancy. See open issues for a list of planned features and known bugs. If you find a bug, have a feature request, or simply a question, please file an issue.
Ensure you have the following requirements installed:
Fork the repository (look for the "Fork" button).
Then clone your fork locally: git clone git@github.com:YOURGITHUBNAME/baldin.git
The development stack is composed of the following services:
Documentation Swagger (Re)docs
After cloning your forked version of the repository, spin up the development stack with the following steps:
backend/.env.example
to create backend/.env
with a valid OPEN_API_KEY
docker-compose up --build
Contributions are welcome! The frontend is built with React and the backend is built with FastAPI. The API is powered by a Postgres database.
Currently the frontend of the application needs to get up to speed with the backend. The backend is in a good place to start building out the frontend.
After running Baldin locally, you're ready to start contributing!
Create a branch for your changes: git checkout -b <issue-number>-branch-name
Make your changes and commit them:
git add . && git commit -m "Your message here"
Push your changes to your fork:
git push origin <issue-number>-branch-name
Open a pull request in the upstream repository (look for the "Pull Request" button).
Wait for your changes to be reviewed and merged!
Note: before committing changes for the first time, run pre-commit install
in the root of the repository.
Commiting modifications to the API endpoints and schemas trigger scripts/fronted_update_schemas.sh
hook to update openapi.json
and frontend/src/schemas.d.ts
.
Generating new API Keys: openssl rand -base64 32
This project is licensed under the terms of the MIT license.