![Logo](aide-logo.png)
The AIDE API is responsible for acting as an intermediary between the AIDE Front-End and downstream services including the MONAI Deploy components; Informatics Gateway and Workflow Manager.
Report Bug
·
Request Feature
Start by cloning or creating a fork of this repository. See GitHub's documentation for help with this: https://docs.github.com/en/get-started/quickstart/fork-a-repo
Secondly ensure that you download and install Node & NPM.
Once you have installed Node and NPM, you can verify that it is correctly installed and referenced in your PATH system variables by executing the following and receiving similar output:
$ node -v
v16.14.0
$ npm -v
8.3.1
Following installation of Node and NPM, you should be able to run the following command to install the referenced project dependencies from the src
folder within the repository:
$ npm install
Following installation of the project dependencies, to begin working on the application, you can execute the following commands to start the API on your local machine.
# Run the application in development mode
$ npm run start
# Run the application in development mode, with file watch mode, where changes will cause the application to reload whilst running.
$ npm run start:dev
# Run the application in production mode
$ npm run start:prod
To verify that your changes haven't affected existing functionality, you can run the unit tests and end-to-end tests, which will be required to pass for any subsequent contribution to the code base:
# Run the unit tests
npm run test:unit
# Run the end-to-end tests
npm run test:e2e
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
AIDE is Apache 2.0 licensed. Please review the LICENCE for details on how the code can be used.