|
1 | 1 | # Reactome |
2 | 2 |
|
3 | | -This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.1.2. |
| 3 | +REACTOME is an open-source, open access, manually curated and peer-reviewed pathway database. |
4 | 4 |
|
5 | | -## Development server |
6 | | - |
7 | | -To start a local development server, run: |
8 | | - |
9 | | -```bash |
10 | | -ng serve |
11 | | -``` |
12 | | - |
13 | | -Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files. |
14 | | - |
15 | | -## Code scaffolding |
16 | | - |
17 | | -Angular CLI includes powerful code scaffolding tools. To generate a new component, run: |
| 5 | +## Local Development Server |
| 6 | +To setup a local environment |
18 | 7 |
|
19 | 8 | ```bash |
20 | | -ng generate component component-name |
| 9 | +npm install --legacy-peer-deps |
| 10 | +npm start |
21 | 11 | ``` |
22 | 12 |
|
23 | | -For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run: |
24 | | - |
25 | | -```bash |
26 | | -ng generate --help |
27 | | -``` |
| 13 | +## Usage |
| 14 | +Reactome has a wide range of features, to explore more of Reactome or get more information visit [the documentation page](https://reactome.org/documentation) or see the ````/documentation```` folder in the root directory. |
28 | 15 |
|
29 | | -## Building |
| 16 | +## Configuration |
30 | 17 |
|
31 | | -To build the project run: |
| 18 | +The application configuration is centralized in TypeScript files under `projects/website-angular/src/config/`. Key configurations include: |
32 | 19 |
|
33 | | -```bash |
34 | | -ng build |
35 | | -``` |
36 | | - |
37 | | -This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed. |
38 | | - |
39 | | -## Running unit tests |
40 | | - |
41 | | -To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command: |
42 | | - |
43 | | -```bash |
44 | | -ng test |
45 | | -``` |
46 | | - |
47 | | -## Running end-to-end tests |
48 | | - |
49 | | -For end-to-end (e2e) testing, run: |
50 | | - |
51 | | -```bash |
52 | | -ng e2e |
53 | | -``` |
| 20 | +- `config.ts`: App-level settings like version, base URLs, and feature flags. |
| 21 | +- `environments.ts`: Environment-specific settings (development, production, etc.). |
| 22 | +- `api-routes.ts`: API endpoint URLs derived from the current environment. |
| 23 | +- `features.ts`: Feature flags for toggling functionality. |
| 24 | +- `external-links.ts`: External links, including dynamically constructed release notes. |
54 | 25 |
|
55 | | -Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs. |
| 26 | +To update configuration values, edit the respective TS files. For environment-specific builds, consider using Angular's file replacements in `angular.json`. |
56 | 27 |
|
57 | 28 | ## Additional Resources |
58 | 29 |
|
59 | | -For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page. |
| 30 | +## LICENSE |
| 31 | +[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) |
0 commit comments