BrowsePing Official Website

Overview

The official website for BrowsePing - an open-source browser extension that transforms your solitary browsing into a vibrant social experience. This Next.js application serves as the main landing page, documentation hub, and information portal for the BrowsePing project.

Visit the live website at browseping.com

Installation for Development

Setup Steps

1. Clone the repository

   git clone https://github.com/browseping/web.git
   cd web

2. Install dependencies

   npm install

3. Configure environment variables (if needed)

   Copy the example environment file:

   cp .env.local.example .env.local

   Edit .env.local to add any required environment variables.

4. Start the development server

   npm run dev

   The application will be available at http://localhost:3000

Available Scripts

The project includes the following npm scripts:

• npm run dev: Starts the development server with Turbopack. This enables hot reloading and fast refresh for an optimal development experience.

• npm run build: Creates an optimized production build. This compiles and optimizes all assets for deployment.

• npm start: Runs the production build locally. Use this to test the production build before deploying.

• npm run lint: Runs ESLint to check for code quality issues and enforce coding standards.

Development Workflow

1. Run npm run dev to start the development server
2. Open http://localhost:3000 in your browser
3. Edit files in the src/ directory - changes will be reflected immediately
4. Run npm run lint before committing to ensure code quality
5. Create a pull request following our Contributing Guidelines

Run the Project Using Docker

Start the development server

docker compose up --build

Once running, open:

http://localhost:3000

Stop the Containers

docker compose down

Project Structure

web/
├── src/
│   ├── app/              # Next.js App Router pages and layouts
│   ├── components/       # Reusable React components
│   └── hooks/            # Custom React hooks
├── public/               # Static assets (images, fonts, etc.)
├── .env.local.example    # Environment variables template
└── package.json          # Dependencies and scripts

Building for Production

To create a production build:

npm run build

This will generate an optimized build in the .next directory. To test the production build locally:

npm start

Deployment

The BrowsePing website is deployed on Vercel, the platform created by the makers of Next.js.

For deployment instructions, see the Next.js deployment documentation.

Contributing

We welcome contributions to the BrowsePing website! Whether it's fixing bugs, improving documentation, or adding new features, your help is appreciated.

Please read our Contributing Guidelines for details on how to get started.

Join our community on Discord to discuss ideas and collaborate with other contributors.

Community & Links

• Website: browseping.com
• Discord: Join our community
• Twitter/X: @BrowsePing
• LinkedIn: BrowsePing Company
• GitHub: github.com/browseping

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

Thanks to all the wonderful people who have contributed to this project.

---