Overview

Streamline your journey to employment with Baldin.

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

🚧 Features + Bugs 🚧

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.

issue tracker

Getting Started

Ensure you have the following requirements installed:

• Docker
• Docker Compose
• Node.js
• TypeScript
• pipenv
• pyenv (or your preferred Python version manager) with Python 3.11.2

Fork the repository (look for the "Fork" button).

Then clone your fork locally: git clone [email protected]:YOURGITHUBNAME/baldin.git

Local Network

The development stack is composed of the following services:

Baldin API Frontend Admin

Documentation Swagger (Re)docs

Building and Running

After cloning your forked version of the repository, spin up the development stack with the following steps:

1. Use backend/.env.example to create backend/.env with a valid OPEN_API_KEY
2. In the root of the reposity run docker-compose up --build

Contributing

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.

5-steps to Contributing

After running Baldin locally, you're ready to start contributing!

1. Create a branch for your changes: git checkout -b <issue-number>-branch-name

2. Make your changes and commit them: git add . && git commit -m "Your message here"

3. Push your changes to your fork: git push origin <issue-number>-branch-name

4. Open a pull request in the upstream repository (look for the "Pull Request" button).

5. 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.

Futher Considerations

• 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

License

This project is licensed under the terms of the MIT license.