/turingAllies

Primary LanguageRubyMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License


Turing Allies

An Open Source project for students to use or contribute to

logo stuff
Explore the docs »

View the site Live! · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Debugging
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is an Open Source project created by Turing students

It started with a simple idea:

create a platform/website or service for Students to see companies that have interviewed or hired Turing students

While the job hunt can be long and difficult, part of the price of admission to Turing is access to it's existing, never-ending network of alumni.

Just like we supported each other through the program itself, I'd like to believe we continue to support each other professionally through the duration of our careers.

At the same time, it's also important to continue to code, build and contribute to Open Source projects.

The amount of complex logic I've ever needed for my day to day job is null. The most complex logic I've ever really had to use is "if this, do this, else, do that". Spending hours doing code challenges is, IMO, less beneficial than building.

Contributing to an Open Source project can be intimidating, especially when you've never done it before.

This project, no matter how inactive, is 100% built by Turing grads and students. You're never out of place by creating a PR for this project. There are safeguards in place that prevent you from ruining anything.

If you'd like to improve, work on, or suggest something for this project while you also search for a job, that's awesome!

Contribute one small thing (whatever you suggest will most likely be merged in) and then you can put it on your resume!

Simple as that.

Obviously contributing more would look better to an employer, but hey, do what you can.

Or just use the website. That's fine too.

(back to top)

Built With

  • Ruby
  • Rails
  • Rspec

(back to top)

Getting Started

Prerequisites

  • ruby v3.1.4
  • rails v7
  • postgresql

Installation

  1. Clone the repo like you normally would, onto your local machine

    git clone git@github.com:TuringAllies/turingAllies.git

  2. CD into the project

    cd turingAllies/

  3. Install packages by running:

    # does the same thing as `bundle install`
bundle

  4. Setup the database

    rails db:create

  5. Run the migrations

    rails db:migrate

  6. Precompile the assets (this might not be necessary; see this doc for more details)

    bundle exec rake assets:precompile

  7. load employer data to be displayed by running the following command

    bundle exec rake csv_load:populate_employers

  8. Copy the file title application.sample.yml and rename it application.yml

    cp config/application.sample.yml config/application.yml

  9. Add the CLIENT_ID and CLIENT_SECRET to application.yml

  • This step is necessary to enable Omniauth with Github locally
  • in the Github repo for the turingAllies ORGANIZATION go to Settings
  • click on "Developer Settings"
  • select "OAuth apps"
  • click "turingAllies"
  • copy the CLIENT_ID and paste it in your application.yml file
  • do the same with the CLIENT_SECRET
  • If you run into any issues with this, DM me on Turing's Slack

(back to top)

Usage

To spin up this project, run the following command from the command line:

bin/dev

navigation to localhost:3000 and see the website there

(back to top)

Debugging

To debug this project, DO NOT start the app with bin/dev.

Instead, start the app with the typical

rails server

Then add a debugger anywhere in the code to hit the binding.

To learn more about the default debugger gem in Rails 7 apps, head over to the debug gem

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  2. Commit your Changes (git commit -m 'Add some AmazingFeature')
  3. Pull the main branch into your feature branch (git pull origin main)
  4. Resolve any merge conflicts locally
  5. Push to the Branch (git push origin feature/AmazingFeature)
  6. Open a Pull Request by completing the PR on github

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Michael Marchand - MichaelDavidMarchand@gmail.com

Project Link: https://github.com/TuringAllies/turingAllies

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)