-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #218 from TogetherCrew/feat/update-readme
update readme file
- Loading branch information
Showing
1 changed file
with
71 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,74 @@ | ||
| [](https://codeclimate.com/github/RnDAO/tc-uiComm/maintainability) | ||
| [](https://codeclimate.com/github/RnDAO/tc-uiComm/test_coverage) | ||
|
|
||
| ### Togethercrew application | ||
| ## 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`. | ||
|
|
||
| ### 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](https://reactjs.org/) and [Next.js](https://nextjs.org/)**: For building the user interface and server-side rendering. | ||
| - **[TypeScript](https://www.typescriptlang.org/)**: For adding type safety to the codebase. | ||
| - **[ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)**: For code formatting and linting. | ||
| - **[Jest](https://jestjs.io/)**: For running tests. | ||
| - **[Material-UI](https://mui.com/) and [Emotion](https://emotion.sh/)**: For UI components and styling. | ||
| - **[Highcharts](https://www.highcharts.com/)**: For data visualization. | ||
| - **[Axios](https://axios-http.com/)**: For making HTTP requests. | ||
| - **[Sentry](https://sentry.io/welcome/)**: For error tracking and monitoring. | ||
| - **[Zustand](https://github.com/pmndrs/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](https://chat.openai.com/c/LICENSE). | ||
|
|
||
| --- | ||
|
|
||
| For more details, refer to the project's documentation or contact the maintainers. |