Skip to content

Latest commit

 

History

History
150 lines (111 loc) · 5.5 KB

README.md

File metadata and controls

150 lines (111 loc) · 5.5 KB

ng-universities

This is a public API of comprehensive, community-driven database of Nigerian universities, their faculties, and departments.

How to Contribute

Data Format:

  • Create a new JSON file in the data/universities/ folder
  • Name the file using the university's lowercase name with hyphens (e.g., kwara-state-university.json)
  • Follow the standard JSON structure provided in the third section below

Contribution Steps:

  1. Fork the repository. You can learn how to do that by watching this video
  2. Clone the repository with this command git clone https://github.com/<YOUR-GITHUB-USERNAME>/ng-universities
  3. Move into the directory with this command cd ng-universities
  4. Create a new branch (git checkout -b add-university-data)
  5. Add your university JSON file or edit a pre-existing university file with more info
  6. Run the data validation script with this command: pnpm run validate-unis. You can also decide to validate a specific file instead of running the validation script on the entire university data by doing the following:
pnpm run validate-unis --file kwara-state-university

Or on a set of files like this:

pnpm run validate-unis --file university-of-lagos,ekiti-state-university
  1. Commit your changes with this command: git commit -m "a message indicating what you've done"

Before you commit, please make sure it follows the conventional commit message pattern. Learn more here. See the following info below:

  • Types: feat, fix, docs, style, refactor, test, chore, etc.
  • Scope: (optional) A noun describing the part of the codebase the commit affects.
  • Description: Short and imperative summary of the change.
git commit -m "fix(ui): resolve navbar bug on mobile"
  1. Create a Pull Request. Watch this

How to Get the Data

For Faculties and Departments:

  1. Visit the school portal (e.g., https://www.unilorin.edu.ng/).
  2. In the navigation menu, hover over Academics to see a dropdown list of all faculties.
  3. To view the departments under a specific faculty:
    • Click on the desired faculty from the dropdown menu.
    • On the faculty's webpage, hover over Departments to see a dropdown list of all departments.
  4. You can either:
    • Manually record the data, or
    • Inspect the webpage's source code to extract the HTML. You can clean and format this data into JSON using tools like ChatGPT.

Note: The school website is the most reliable source for updated data. However, feel free to explore other options if they are more convenient.

For Universities' Logos:

  1. Go to Nigerian University Logos on MySchoolPortal.
  2. Find the logo of the university you are researching.
  3. Click on the logo to open it in a new tab.
  4. Once the logo page is open:
    • Right-click on the logo.
    • Choose Save image as or a similar option to download it.

ng-univerisities-logo-copy

Note: If the logo for a specific university is unavailable on the portal, try these alternative sources:

  • The university’s official website.
  • Wikipedia.
  • News outlets or other trusted platforms.

Data Validation

Before submitting:

  • Ensure all required fields are filled
  • Validate JSON structure
  • Check for accuracy of information

If you forget to do this, do not fret. The CI workflow will help us detect it in your PR.

Below is an example structure we're looking for.

{
  "logo": "",
  "current_vc": "",
  "name": "Full University Name",
  "acronym": "Acronym",
  "location": {
    "city": "City Name",
    "state": "State Name"
  },
  "founded": 1900,
  "website": "https://university.edu.ng",
  "faculties": [
    {
      "acronym": "Acronym",
      "name": "Faculty Name",
      "departments": [
        { "acronym": "department acronym", "name": "department name" },
        { "acronym": "department acronym", "name": "department name" }
      ]
    }
  ]
}

You can find a couple of university logos here

Troubleshooting Guide:

  1. This project uses pnpm for package management. If you don't have it installed, you can do so by running the following command:

    npm install -g pnpm

    Alternatively, you can follow the comprehensive installation guide.

  2. If you've mistakenly used npm, yarn, or any other package manager, please follow these steps:

    • Delete the node_modules folder and any lock files (e.g., package-lock.json, yarn.lock, etc.).

    • Reinstall the packages using pnpm by running:

      pnpm install

  3. To ensure you're working with the latest version of the project and avoid conflicts, make sure your forked repository is up to date with the main repo. Here's how:

    • Navigate to your forked repo at https://github.com/<YOUR-GITHUB-USERNAME>/ng-universities.
    • Click on the Sync Fork button and then click Update Branch: image

  4. It's always a good idea to check the README page for any recent changes or updates.

License

MIT