Skip to content

Feat/dx improments #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adedoyin-paystack merged 11 commits into from
Jan 15, 2026
Merged

Feat/dx improments #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1372f8f
chore: add vite
aeadedoyin Jan 15, 2026
ab6fb76
feat: fix all deprecated scss issues
aeadedoyin Jan 15, 2026
50cffe6
chore: improve header ui
aeadedoyin Jan 15, 2026
655fcf4
chore: add ios style toggle
aeadedoyin Jan 15, 2026
7a310e3
chore: fix search dark mode
aeadedoyin Jan 15, 2026
9fed087
chore: upgrade lint packages
aeadedoyin Jan 15, 2026
de4b72a
fix: setup vite public dir for static assets
aeadedoyin Jan 15, 2026
7474eaf
chore: ensure builds run without warnings/errors
aeadedoyin Jan 15, 2026
77b9bc0
refactor: move js and scss to src folder
aeadedoyin Jan 15, 2026
c0acc77
chore: standardize index.html
aeadedoyin Jan 15, 2026
0b824b9
chore: update readme and contributing files
aeadedoyin Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ css
node_modules
.DS_Store
.idea
dist
.context
41 changes: 24 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,40 @@ This is an open source project for downloading free, high quality vector logos o

## Getting Started

NigeriaLogos is a simple web app built with HTML and plain Javascript. Styles are written in SCSS and compiled locally. Follow the instructions below to set up the project on your local machine for development and testing purposes.
NigeriaLogos is a simple web app built with HTML and plain Javascript, powered by [Vite](https://vitejs.dev/) for fast development and builds. Styles are written in SCSS. Follow the instructions below to set up the project on your local machine for development and testing purposes.

### Prerequisites
[Node.js](https://nodejs.org/)

- [Node.js](https://nodejs.org/) (v20.0.0 or higher)

### Running this project locally
- Clone the project to your computer.
- Install dependencies with
`$ npm install`

- Serve with hot reload at _localhost:8080_ or some random port if 8080 is in use.
`$ npm run dev`
1. Clone the project to your computer.

2. Install dependencies:

```bash
npm install
```

- Optionally: If you don't want to serve with hot reload as above
- generate css/main.css
`$ npm run build`

- generate and automatically update css/main.css as scss/* files changes
`$ npm run watch`
3. Build the project:

```bash
npm run build
```

4. Start the development server with hot reload:
```bash
npm run dev
```
This will serve the app at `http://localhost:8080` (or `8081`, `8082`, etc. if the port is in use).

## Contributing

To learn more about contributing to NigeriaLogos, please read [contributing.md](https://github.com/PaystackHQ/nigerialogos/blob/master/contributing.md)


## Authors

* [**Demilade Olaleye**](https://github.com/Demilad)
* [**Chinonso Raymond**](https://twitter.com/ChinonsoRay)
* [**Adedoyin Akande**](https://github.com/aeadedoyin)
- [**Demilade Olaleye**](https://github.com/Demilad)
- [**Chinonso Raymond**](https://twitter.com/ChinonsoRay)
- [**Adedoyin Akande**](https://github.com/aeadedoyin)
173 changes: 94 additions & 79 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,112 +3,127 @@
There are two ways to contribute to this project:

## Using the form

You can upload your logos directly to the online form here: https://airtable.com/shr3BAQio2rPWaGN7. This usually takes about 72 hours to be reviewed and merged.

## Sending in a pull request

Another way to contribute is to directly send in a pull request. Here are some guidelines for this:

1. Ensure your logos have been properly optimised with tools like:
[SVGOMG](https://jakearchibald.github.io/svgomg/) &
[Squoosh](https://squoosh.app/) **(OxiPNG works well)**. Kindly ensure your file sizes are as small as possible. Also, your SVG file should be text-only and not contain any bitmaps.
[SVGOMG](https://jakearchibald.github.io/svgomg/) &
[Squoosh](https://squoosh.app/) **(OxiPNG works well)**. Kindly ensure your file sizes are as small as possible. Also, your SVG file should be text-only and not contain any bitmaps.

2. Add a folder to **logos** named after your company. In this folder, put the svg and png versions of your logo. The files should have the same name as the folder and should be lowercase. If your company name has multiple words, kindly separate them with an underscore.
2. Add a folder to **public/logos** named after your company. In this folder, put the svg and png versions of your logo. The files should have the same name as the folder and should be lowercase. If your company name has multiple words, kindly separate them with an underscore.

### Folder Structure

```
company_name
| company_name.png
| company_name.svg
public/logos/company_name
├── company_name.png
└── company_name.svg
```

3. In **[logos.json](https://github.com/PaystackHQ/nigerialogos/blob/master/logos.json)**, add a `JSON` entry for your company
3. In **[public/logos.json](https://github.com/PaystackHQ/nigerialogos/blob/master/public/logos.json)**, add a `JSON` entry for your company

### JSON Object
```

```json
{
"title": "Company Name",
"filename": "company_name",
"url": "https://company_url.com",
"category": ["Category"]
"title": "Company Name",
"filename": "company_name",
"url": "https://company_url.com",
"category": ["Category"]
}
```

**Example**
```

```json
{
"title": "Polaris Bank",
"filename": "polaris_bank",
"url": "https://www.polarisbanklimited.com/",
"category": ["Banking", "Financial Services"]
"title": "Polaris Bank",
"filename": "polaris_bank",
"url": "https://www.polarisbanklimited.com/",
"category": ["Banking", "Financial Services"]
}
```

4. If your company category is not reflected in categories section *below*, feel free to use a new category.
If you do so, kindly edit this file; adding the newly used category (**[/contributing.md](https://github.com/PaystackHQ/nigerialogos/blob/master/contributing.md)**) in your PR as well.
**NB:** Your jsonObject category can also be a combined form 2 or more categories in this form: **e.g.**
```
"category": ["NGO", "Ecommerce"] or
"category": ["NGO", "Ecommerce", "Marketplace"] or
"category": ["NGO"]
```
4. If your company category is not reflected in categories section _below_, feel free to use a new category.
If you do so, kindly edit this file; adding the newly used category (**[/contributing.md](https://github.com/PaystackHQ/nigerialogos/blob/master/contributing.md)**) in your PR as well.

**NB:** Your jsonObject category can also be a combined form 2 or more categories in this form:

```json
"category": ["NGO", "Ecommerce"]
// or
"category": ["NGO", "Ecommerce", "Marketplace"]
// or
"category": ["NGO"]
```

5. Make sure your company URL has the `http://` or `https://` prefix or it will be rendered as invalid (this is to prevent some quirks in link redirection).
**NB:** By default, all empty or invalid urls will be linked to google search rather than the official website.
```
"url": "https://paystack.com" or
"url": "https://www.paystack.com"
not
"url": "paystack.com" or
"url": "www.paystack.com"
```

**NB:** By default, all empty or invalid urls will be linked to google search rather than the official website.

```json
"url": "https://paystack.com"
// or
"url": "https://www.paystack.com"
// not
"url": "paystack.com"
// nor
"url": "www.paystack.com"
```

### Categories

```
* Lending
* Banking
* Financial Services
* Branding
* Construction
* Coworking
* CRM
* Virtual Office
* Cryptocurrency
* Ecommerce
* Marketplace
* NGO
* EdTech
* FMCG
* Conglomerate
* Foundation
* Gaming
* Sports
* Government Agency
* Health
* Media
* Entertainment
* Newspaper
* Blog
* Petroleum and Gas
* Product Design
* Real Estate
* Restaurant
* Software
* ICT
* Telecommunication
* ISP
* Transportation
* Agritech
* Publishing
* Web Host
* Domain Registrar
* Local Search
* Business Ratings and Reviews
* Online Food Delivery
* Event Management
* PropTech
* Groceries
* Pharmacy
* Home Services
* Website Builder
Lending
Banking
Financial Services
Branding
Construction
Coworking
CRM
Virtual Office
Cryptocurrency
Ecommerce
Marketplace
NGO
EdTech
FMCG
Conglomerate
Foundation
Gaming
Sports
Government Agency
Health
Media
Entertainment
Newspaper
Blog
Petroleum and Gas
Product Design
Real Estate
Restaurant
Software
ICT
Telecommunication
ISP
Transportation
Agritech
Publishing
Web Host
Domain Registrar
Local Search
Business Ratings and Reviews
Online Food Delivery
Event Management
PropTech
Groceries
Pharmacy
Home Services
Website Builder
```

**NOTE**: _Pull requests are usually reviewed within 24 hours. Once your pull request is merged, you should see your logo on the site a few minutes after._
Loading
Loading