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.
Before you begin, ensure you have the following installed:
- Node.js (version 18.11.9 or higher)
- npm (comes with Node.js)
- Clone the repository to your local machine.
- Navigate to the project directory.
- Run
npm installto install all the dependencies listed inpackage.json.
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.
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.
Contributions are welcome! Please read our contributing guidelines before submitting pull requests.
This project is licensed under the MIT License.
For more details, refer to the project's documentation or contact the maintainers.