Skip to content

Latest commit

 

History

History
255 lines (185 loc) · 8.38 KB

README.md

File metadata and controls

255 lines (185 loc) · 8.38 KB
Raw

Contributors Forks Stargazers Issues Pulls MIT License LinkedIn


Logo

Saikai

Manage Your Way To Work!
Explore the docs »

View Website · Report Bug · Contact Us

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

About The Project

From 01/06/2023 we are working again on this project!

This project was deprecated for long time, and now, we have the ability to work on it again.

product-screenshot

400 job applications ➡ 100 interviews ➡ 10 home tasks ➡ 1 contract.

Pretty simple, right? Until you need to keep track of your job search! And that's where Saikai comes in.

Saikai is a web platform, where job seekers can keep track of their job applications and organize their job search.

In Saikai, you can log any detail regarding the job applications and quickly get a clear vision of how your job search is going.

Saikai helps you to manage all the information you need in order to be right on ready once you get a call back from your dream company. Here you can organize all the position details including position description, status, applied date and many more!

Built With

Getting Started

Prerequisites

Install Node.

  • npm 
    npm install npm@latest -g

Installation

  1. Get a free API Key at Firebase console.
  2. Clone the repo 
    git clone https://github.com/Saikai-oyo/Saikai.git
  3. Install NPM packages 
    npm install
  4. Create .env.local file and enter your API in (you will get 7 keys) 
    REACT_APP_FIREBASE_API_KEY= THE_API_RELEVANT_KEY
REACT_APP_FIREBASE_AUTH_DOMAIN= THE_API_RELEVANT_KEY
REACT_APP_FIREBASE_PROJECT_ID= THE_API_RELEVANT_KEY
REACT_APP_FIREBASE_STORAGE_BUCKET= THE_API_RELEVANT_KEY
REACT_APP_FIREBASE_MESSAGING_SENDER_ID= THE_API_RELEVANT_KEY
REACT_APP_FIREBASE_APP_ID= THE_API_RELEVANT_KEY
REACT_APP_FIREBASE_MEASUREMENT_ID= THE_API_RELEVANT_KEY
  5. Start the application 
    npm started

Usage

1️⃣ Create your own Saikai profile, to keep track of your personal progress

2️⃣ Add new position you applied your CV to and log all the details you need (title, company, description, status, applied date, HR details, position link etc.)

3️⃣ Watch all the entered information of the position by clicking on it from the main board. Navigate between position details and position description

4️⃣ Edit position details, by clicking on the pencil of the "view position" modal

5️⃣ Watch all positions on the main board, and get a quick access to each position information.

6️⃣ Drag positions between different status bar as you progress with the process of the specific job, in order to update the position status (You can also change the status manually on "edit position" mode)

7️⃣ Order the positions in each status bar by preferred order: by date, alphabet and free-style

8️⃣ Search for a specific position in the search bar at the top - search by position title, company name or description key words (very useful once you get a call and need a quick reminder of this application 😉)

  • Your time should be focused on creating something amazing. A project that solves a problem and helps others
  • You shouldn't be doing the same tasks over and over like creating a README from scratch
  • You should element DRY principles to the rest of your life.

Roadmap

See the Next Milestones for a list of proposed features (and known issues) for the next milestones.

Contributing

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

  1. Speak with Idan at LinkedIn to be formal contributing
  2. Fork the Project.
  3. Create your Feature Branch.
  4. Commit your Changes.
  5. Push to the Branch.
  6. Open a Pull Request.

Convention

Branch

Branch naming convention is as following:

TYPE-ISSUE_ID-DESCRIPTION

examples:
feat-45-add-new-button
fix-741-change-localstorage-get-function

Pull Request (PR)

Pull Request (PR) title convention is as following:

[TYPE-ISSUE_ID]-DESCRIPTION

example:
[Feat-45] Add button to login component
[Fix-114] Change localstorage get function

Commits

Commit information convention is as following:

[TYPE-ISSUE_ID]-DESCRIPTION

example:
[Feat-45] Add button to login component
[Fix-114] Change localstorage get function

Type

When type can be:

* feat - is a new feature
* doc - documentation only changes
* fix - a bug fix
* refactor - code change that neither fixes a bug nor adds a feature

All PRs must include commit message with the changes description!

License

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

Contact

📧 Via email - ContactUs@Saikai.me

🔥 Project Github Link: https://github.com/Saikai-oyo/Saikai

🔗 Website : https://saikai.me

👨🏾‍💻 Open-source Manager (Idan) - LinkedIn