Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Latest commit

 

History

History
61 lines (48 loc) · 1.56 KB

README.md

File metadata and controls

61 lines (48 loc) · 1.56 KB
Raw

ReGuilded Website

ReGuilded is a client injector/client mod that allows you to extend the functionality of Guilded's client by providing theme and addon support.

Technologies

The technologies used to make the ReGuilded website:

  • TypeScript
  • Next.js
  • React
  • Chakra
  • Next-I18Next

Note: More will be added soon.

Self-Hosting

  1. Clone the repository
git clone https://github.com/ReGuilded/ReGuilded-website.git
  1. Install the dependencies
yarn
# or
npm install
# or
pnpm install

Note: The project uses yarn, otherwise you can choose to use npm or pnpm instead.

  1. Run the local development server
yarn dev
# or 
npm run dev
# or
pnpm run dev

You can use another port by adding the --port flag.

  1. Open the browser to http://localhost:3000/. Or open it to the custom port you used (if you did).

Roadmap

The roadmap for the website, and what we're planning on implementing. Note that this is subject to change, and your suggestions are welcome!

  • Landing page
  • Contributors
  • Dashboard
    • Authentication
    • Backend API
  • ReGuilded Public API

Contributing

Contributions are welcome. Our rules for contributions:

  1. Make sure that naming conventions are similar
  2. In your commit message, roughly include your changes. But, in your description, include a detailed summary of your contributions and we will review it
  3. Coordinate with us on Guilded before making any changes.

Other than that, just create a pull request with your changes and we will make sure to review them!