https://github.com/prabapro/apps-prabapro-me
Praba's Apps
https://github.com/prabapro/apps-prabapro-me
jamstack vanilla-js vite
Last synced: 3 months ago
JSON representation
Praba's Apps
- Host: GitHub
- URL: https://github.com/prabapro/apps-prabapro-me
- Owner: prabapro
- Created: 2024-09-15T11:12:38.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-02T05:46:37.000Z (3 months ago)
- Last Synced: 2025-04-04T23:09:06.201Z (3 months ago)
- Topics: jamstack, vanilla-js, vite
- Language: JavaScript
- Homepage: https://apps.prabapro.me
- Size: 301 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Praba's Apps
This project is a Vite-based vanilla JavaScript application designed to showcase a collection of apps. It features dynamically generated pages for each app and its corresponding privacy policy, all created from Markdown files.
## Features
- Vite-powered for fast development and optimized production builds
- Vanilla JavaScript with a component-based architecture
- Dynamic routing without a framework
- Markdown-based content management for apps and privacy policies
- Custom Vite plugin for processing Markdown files
- Responsive design using Bootstrap
- Google Tag Manager integration for analytics
- Automated app page creation script
## Prerequisites
- Node.js (version 14 or later recommended)
- npm (comes with Node.js)
## Setup
1. Clone the repository:
```
git clone [email protected]:prabapro/apps-prabapro-me.git
cd apps-prabapro-me
```
2. Install dependencies:
```
npm install
```
3. Start the development server:
```
npm run dev
```
4. Open your browser and navigate to `http://localhost:8080`
## Project Structure
- `src/`: Contains the main application code
- `components/`: Reusable UI components
- `utils/`: Utility functions
- `index.html`: Main HTML file
- `main.js`: Application entry point
- `style.css`: Global styles
- `content/`: Markdown files for app descriptions and privacy policies
- `apps/`: App description files
- `privacy-policies/`: Privacy policy files
- `public/`: Static assets
- `vite.config.js`: Vite configuration
- `vite-plugin-app-data.js`: Custom plugin for processing Markdown files
- `create-app.js`: Script for creating new app pages
## Adding a New App
1. Run the create-app script:
```
npm run create-app
```
2. Enter the name of your new app when prompted.
3. The script will create two new files:
- `content/apps/.md`: App description
- `content/privacy-policies/.md`: Privacy policy
4. Edit these files to add your app's details and privacy policy.
5. Add an app logo image at `public/images/.jpg`.
## Building for Production
To create a production build:
```
npm run build
```
The built files will be in the `dist/` directory.
## Preview Production Build
To preview the production build:
```
npm run preview
```