https://github.com/wavy-bot/website

Website & dashboard combo for Wavy.
https://github.com/wavy-bot/website

discord discord-bot nextjs tailwindcss

Last synced: 6 days ago
JSON representation

Website & dashboard combo for Wavy.

• Host: GitHub
• URL: https://github.com/wavy-bot/website
• Owner: Wavy-Bot
• License: gpl-3.0
• Created: 2022-04-24T19:23:46.000Z (almost 3 years ago)
• Default Branch: production
• Last Pushed: 2023-10-07T00:46:15.000Z (over 1 year ago)
• Last Synced: 2024-11-16T23:21:37.589Z (2 months ago)
• Topics: discord, discord-bot, nextjs, tailwindcss
• Language: TypeScript
• Homepage: https://wavybot.com
• Size: 642 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![GitHub](https://img.shields.io/github/license/Wavy-Bot/website?color=A42E2B&logo=gnu&logoColor=white&style=for-the-badge)

[![Discord](https://img.shields.io/discord/710436465938530307?color=%235865F2&label=Discord&logo=discord&logoColor=white&style=for-the-badge)](https://discord.wavybot.com)

# Wavy website

This is the Wavy website & dashboard combo website. It is written in Next.js (which is a framework around React) allowing it to feel very snappy whilst enabling traditional SEO options.

## For maintainers

For those looking to maintain this codebase here are some of the basic things you'll need to know:

* We use yarn here, since it offers caching for dependencies. If you do not have yarn installed you can install it by running `npm i yarn -g` on your system.

* This website is written in TypeScript, which is a superset of JavaScript. This means that it is fully compatible with JavaScript but also adds a lot of extra features. If you are not familiar with TypeScript you can read more about it [here](https://www.typescriptlang.org/).

## Running locally

After cloning / pulling the repository you should install the dependencies using `yarn`. Once that is done you can run the development server using `yarn dev`. This will start a development server on port 3000. You can access the website by going to `http://localhost:3000`.

## Deployment

To deploy you'll have to open a pull request comparing `production` to `development`. Once that is done you can merge the pull request, or wait for someone to do so if you don't have sufficient permissions, and the website will be deployed to the production server.

## License

See [LICENSE.MD](https://github.com/Wavy-Bot/website/blob/main/LICENSE.md).