-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add missing setup instructions and coveralls badge
- Loading branch information
Showing
1 changed file
with
7 additions
and
5 deletions.
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,24 +1,26 @@ | ||
| # CRDC Data Hub | ||
|
|
||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://coveralls.io/github/CBIIT/crdc-datahub-ui?branch=main) | ||
|
|
||
| CRDC Data Hub is a React application designed to provide a user-friendly interface for accessing and managing data using various technologies and tools. This project utilizes TypeScript, React v18, Material-UI v5, ESLint, React Router DOM, GraphQL, and Apollo. | ||
| CRDC Data Hub is a React application designed to provide a user-friendly interface for accessing and managing data using various technologies and tools. This project utilizes Node `20.11`, TypeScript, React `v18`, Material-UI `v5`, GraphQL, and Apollo. | ||
|
|
||
| ## Installation | ||
|
|
||
| To run the CRDC Data Hub project locally, follow these steps: | ||
|
|
||
| 1. Clone the repository | ||
| 2. Navigate to the project directory | ||
| 3. Install the dependencies: `npm ci` | ||
| 4. Start the development server: `npm start` | ||
| 5. Open your browser and visit `http://localhost:3000` to access the application. | ||
| 3. Copy `.env.example` to `.env` and update the environment variables as needed | ||
| 4. Install the dependencies: `npm ci` | ||
| 5. Start the development server: `npm start` | ||
| 6. Open your browser and visit `http://localhost:3010` to access the application. | ||
|
|
||
| Please see the instructions in [nginx/README.md](./nginx/README.md) for configuring Nginx. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We use Husky to run a pre-commit hook that will run ESLint and Prettier on staged files. If there are any issues, you will need to fix them before you can commit your changes. | ||
| We use Husky to run a pre-commit hook that will run ESLint and Prettier checks on staged files. If there are any issues, you will need to fix them before you can commit your changes. | ||
|
|
||
| If you need to bypass the pre-commit hook, you can use the Git `--no-verify` flag when committing your changes. | ||
| These same issues will still be caught by the CI/CD pipeline. |