https://github.com/vivek-nexus/project-pratima
An icon library for all financial institutions in India.
https://github.com/vivek-nexus/project-pratima
documentation icon-library icons iconset india nextjs payments website
Last synced: 2 months ago
JSON representation
An icon library for all financial institutions in India.
- Host: GitHub
- URL: https://github.com/vivek-nexus/project-pratima
- Owner: vivek-nexus
- Created: 2022-07-16T09:44:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-25T04:53:56.000Z (over 1 year ago)
- Last Synced: 2025-02-10T04:14:43.846Z (4 months ago)
- Topics: documentation, icon-library, icons, iconset, india, nextjs, payments, website
- Language: JavaScript
- Homepage: https://paymentscouncil.in/project-pratima
- Size: 6.76 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Project pratima
### An icon library for all financial institutions in India.
Official website: https://paymentscouncil.in/project-pratima
Github staging deployment: http://vivek-nexus.github.io/project-pratima/
---
## Pre-requisities
- `node`
- `yarn`
- `zip`
---
## Run locally
1. Clone the repository
2. Run `yarn` to install all packages
3. Run `yarn dev` to view on the site on `localhost:3000`
## Deployment
Make sure to do all the steps below, in the same order.
1. In `next.config.js`, configure `LINK_PREFIX`, `basePath` and `assetPrefix`. Change to blank value if the webpage is served directly from root of the domain.
2. In `_document.js`, update the meta tags that specify `property="og:url"` and `property="og:image"`, with the absolute URL of the domain where the website will be deployed.
3. Mandatorily, run `yarn zip` to generate the zip file for all icons, which is needed for "Download all" button of icon library.
4. Run `yarn build && yarn export` to generate static HTML.
5. Static HTML is dumped to `out` directory of the project. Grab the files and host it on any server.
6. Optionally, automate these steps with a deployment script of your choice. See a sample deployment script for Github actions [here](.github/workflows/gh-pages.deploy.yml).