Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 3.73 KB

README.md

File metadata and controls

100 lines (63 loc) · 3.73 KB
Raw

Forums Frontend

Welcome to the LunarLabs's Forums repository! This project is an open-sourced frontend application based on the design of Cobra.gg's Forums. We originally developed this project for our own use, but due to unfortunate circumstances, we've decided to share it with the community. We hope it finds a new purpose and benefits others! This project depends on a backend API or else it will not WORK this was made to work with Refine's API for Phoenix you can get it here by buying Phoenix and contacting Creaxx. We are actively working on making it work with Catalyst a RestAPI by @GrowlyX you can purchase Catalyst here

Anyone is allowed to use this but we do ask that you keep our credit footer at the bottom as we worked alot on this. Even if you decide to fork it we ask you keep the credit or put credit for us somewhere <3

Overview

This is a frontend application built with Next.js. It offers a modern and sleek user interface and can be used as a foundation for various web applications. The project is designed to be easily customizable and extendable.

Default Homepage with no posts Screenshot of the forum interface without news/announcements posted

A view of the Forums Another view of the forums

A view of User Profiles A view of user profiles

A view of the Posts Another view of the posts

A view of the home page with announcements Screenshot of the forum interface with news/announcements posted

A view of the Staff page Screenshot of the Staff Page

A view of the Settings page Screenshot of the Staff Page

Features

  • Built with Next.js
  • Modern, responsive design
  • Based on Cobra.ggs design
  • Easy to customize and extend

Prerequisites

Before you begin, ensure you have met the following requirements:

Installation

  1. Clone the repository:

    git clone https://github.com/lunarlabsllc/Forums-Frontend.git

  2. Navigate to the project directory:

    cd Forums-Frontend

  3. Install dependencies using Yarn:

    yarn install

  4. Start the development server:

    yarn dev

  5. Open your browser and navigate to http://localhost:3000 to see the application in action.

Contributing

We welcome contributions from the community! To contribute to the project, please follow these guidelines:

  1. Fork the repository and create a new branch for your feature or bug fix.
  2. Make your changes and test them thoroughly.
  3. Submit a pull request with a clear description of your changes and any relevant details.

Pull Request Rules

  • Describe your changes: Clearly explain the purpose and scope of your changes.
  • Follow code conventions: Adhere to the existing coding style and practices used in the project.
  • Test your code: Ensure that your changes do not break existing functionality and that new features work as intended.
  • Update documentation: If your changes affect the documentation, make sure to update it accordingly.

License

This project is licensed under the MIT License.

Contact

For any questions or support, please open an issue in this repository or contact us at [[email protected]].

Thank you for checking out our fourms! We hope you find it useful and welcome any contributions you can make to improve it.