Code Monkey home page Code Monkey logo

eggtray's Introduction

Eggtray ๐Ÿฅš

Entry level candidates API

Add yourself

If you're looking for an entry level software engineering job, send a Pull Request adding a new YAML file (RealPython has a good intro to YAML) to the ./profiles directory. Each YAML file in that directory represents a profile of a single person:

  • Name of the file must be your GitHub username
  • The file must have the .yml extension
  • See existing files to learn about the format of the YAML document

Once the PR gets accepted, Eggtray uses Hen to inspect your GitHub profile. It merges the findings with data from the YAML file and creates a single data structure, which is then available in the API as your profile information.

If you want to change something in the YAML, send another PR. If you found a job (congratulations!) and now want to remove yourself from the API, send a PR removing your YAML file.

Note

The API updates only once a day. If you change someting on your GitHub profile or in your YAML file, it can take up to 24 hours to take effect in the API.

API usage

Open juniorguru.github.io/eggtray/profiles.json. That's it! As of now, there are no limitations on what you can do with the API. You can use the data for any purpose, even commercial, and there is no rate limiting.

The API has been created for the purpose of listing entry level candidates on junior.guru/jobs, but is open to anyone. If you use the API, file an issue and let's link your project from this document.

Caution

As of now, the API is extremely UNSTABLE. There are no guarantees on schema of the response. Anything can and will change over night.

License

AGPL-3.0-only, copyright (c) 2024 Jan Javorek, and contributors.

eggtray's People

Contributors

honzajavorek avatar dependabot[bot] avatar marcel-git666 avatar sandraheinzova avatar

Watchers

 avatar

eggtray's Issues

Write the docs!

There are no docs on how to add yourself, how it all works, etc.

Add license

I'm not sure yet what license is the best for this project ๐Ÿค”

More data

  • name
  • name override
  • bio
  • bio override
  • topics (frontend, backend...)
  • location
  • linkedin
  • email
  • intro
  • project image / gif / video
  • education (zs, ss, vs, unfinished... + field)
  • experience (field + years)
  • courses (JG courses?)
  • languages

Automatic PR check

Under a PR,

  • run tests
  • based on test results, comment under the PR with a canned message (maybe schema is wrong? etc.)
  • identify sender of the PR and run a hen check against their YAML file
  • based on the hen results, comment under the PR with basic info (recommendations about the profile, if there are errors then mention that the profile might not get through)

Remove courses

Courses are most likely irrelevant to recruiters or hiring managers. We don't even mention specific schools. The candidate should shine through their projects.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.