Skip to content

Latest commit

 

History

History
114 lines (69 loc) · 2.58 KB

File metadata and controls

114 lines (69 loc) · 2.58 KB

Dan's Plugins Community Website

Description

Dan's Plugins Community Website is a Next.js web application that serves as the central hub for the Dan's Plugins Community. It showcases DPC plugins, provides links to documentation and support resources, and acts as the public face of the community at https://dansplugins.com.

Installation

First Time Installation

  1. Ensure Node.js (v18 or later) is installed on your machine.
  2. Clone this repository: git clone https://github.com/Dans-Plugins/dansplugins-dot-com.git
  3. Install dependencies:
    npm install
  4. Build the project:
    npm run build
  5. Start the server:
    npm run start

The site will be available at http://localhost:3000.

Docker Compose (Recommended for Development)

See the Development section below.

Usage

Documentation

Website

Support

You can find the support Discord server here.

Experiencing a bug?

Please fill out a bug report here.

Contributing

Testing

Lint

Linux:

npm run lint

Windows:

npm run lint

If you see no errors, the lint check has passed.

Development

Test Server with Hot-Reloading

A Docker Compose setup is available for local development.

Setup

  1. Install Docker Desktop.
  2. Start the development server:
    ./up.sh
    The site will be accessible at http://localhost:3000.

Stopping the Server

./down.sh

Manual npm Dev Server

npm run dev

Authors

Developers

Name Main Contributions
Dans Project founder and lead developer

License

This project is licensed under the MIT License.

You are free to use, modify, and distribute this software, provided that the original copyright and license notice are included.

See the LICENSE file for the full text.

Project Status

This project is in active development.