Overview

Welcome to the Togethercrew project! This repository contains a Next.js application with a rich set of features and dependencies geared towards building a robust and scalable web application.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (version 18.11.9 or higher)
• npm (comes with Node.js)

Installation

1. Clone the repository to your local machine.
2. Navigate to the project directory.
3. Run npm install to install all the dependencies listed in package.json.

Environment Variables

To set up environment variables:

1. Copy the Example File:
   Run:

   cp .env.example .env.local

2. Update Variables:
   Replace placeholders in .env.local with actual values.

Note: Do not commit .env.local to version control; use .env.example to document new variables.

Premium Guilds Configuration

The application includes a list of premium platforms, defined in the PREMIUM_GUILDS array. Premium platforms receive special treatment or features within the application.

How to Add a New Premium Platform

1. Locate the PREMIUM_GUILDS array in the configuration file:

   export const PREMIUM_GUILDS = [
     '732892373507375164', // fuel
     '915914985140531240', // rndao
     '980858613587382322',
     '1007641784798691468',
   ];

2. Add the new platform's unique ID to the array. For example:

   export const PREMIUM_GUILDS = [
     '732892373507375164', // fuel
     '915914985140531240', // rndao
     '980858613587382322',
     '1007641784798691468',
     '123456789012345678', // new platform
   ];

Notes

• The platform ID must be a unique identifier.

This setup allows for easy customization and management of premium platforms in the application.

Available Scripts

In the project directory, you can run:

• npm run dev
  Starts the development server.

• npm run build
  Builds the app for production.

• npm run start
  Runs the built app in production mode.

• npm run lint
  Runs ESLint to catch linting errors.

• npm run test
  Launches the test runner.

• npm run coverage
  Generates test coverage.

• npm run export
  Exports a static version of the app.

Dependencies

The project uses a variety of dependencies for different purposes:

• React and Next.js: For building the user interface and server-side rendering.
• TypeScript: For adding type safety to the codebase.
• ESLint and Prettier: For code formatting and linting.
• Jest: For running tests.
• Material-UI and Emotion: For UI components and styling.
• Highcharts: For data visualization.
• Axios: For making HTTP requests.
• Zustand: For state management.

And many others that enhance the functionality and performance of the application.

Contributing

Contributions are welcome! Please read our contributing guidelines before submitting pull requests.

License

This project is licensed under the MIT License.

---

For more details, refer to the project's documentation or contact the maintainers.