https://github.com/devbm7/policy-viewer
https://github.com/devbm7/policy-viewer
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/devbm7/policy-viewer
- Owner: devbm7
- Created: 2025-02-27T12:54:06.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-14T20:36:02.000Z (about 1 year ago)
- Last Synced: 2025-03-14T21:33:54.416Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://policy-viewer.vercel.app
- Size: 313 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Policy Viewer
## Overview
A Next.js React project for visualizing and exploring data with markdown rendering and interactive components. Purpose is to
## Features
- Next.js Pages Router
- React Markdown rendering
- Syntax highlighting
- Dark/Light mode support
- Responsive design
- Custom logo and navigation
## Prerequisites
- Node.js (v16+)
- npm or yarn
## Installation
1. Clone the repository
```bash
git clone https://github.com/devbm7/policy-viewer.git
cd project-viewer
```
2. Install dependencies
```bash
npm install
# or
yarn install
```
## Running the Project
- Development mode
```bash
npm run dev
# or
yarn dev
```
- Production build
```bash
npm run build
npm start
# or
yarn build
yarn start
```
## Project Structure
```
/
├── pages/
│ ├── index.tsx
│ └── ...
├── public/
│ └── favicon.ico
├── resources/
│ └── topicsData.ts
└── styles/
└── globals.css
```
## Technologies
- Next.js
- React
- Tailwind CSS
- React Markdown
- Syntax Highlighter
## Customization
- Modify `topicsData.ts` to update content
- Adjust Tailwind config for theming
- Customize Logo and Layout components
## Contributing
1. Fork the repository
2. Create your feature branch
3. Commit changes
4. Push to the branch
5. Create a pull request
## License
MIT License