dev.aireadi.org

Software development best practices for the AI-READI project

Sublink 1 · Documentation · Changelog · Report Bug · Request Feature

---

Description

This documentation is a central repository for storing developer information on the fairhub.io project. It is intended to be used by the developer team for getting instructions on running, building, and releasing our projects.

Getting started

For instructions on how to install and build these docs, see the README file.

⚠️ Prerequisites

This project uses Yarn as package manager.

npm install --global yarn

If you already have a Anaconda environment on your machine, you can install the dependencies with:

conda install -c conda-forge yarn nodejs

Run locally

Clone the project

https://github.com/AI-READI/dev.aireadi.org.git

Go to the project directory

cd dev.aireadi.org

Install dependencies

yarn install

Start the server

yarn dev

Build locally

Use this step to build a local production version of the site. Use docs:serve to preview the local build.

yarn docs:build
yarn docs:serve

Deployment

This repository is automatically deployed to Azure on every push to the repository. If you need to reference a specific branch or pull request, you can do so by using the following URL pattern:

• https://wonderful-tree-09f1c2410-<BRANCH_NAME>.centralus.2.azurestaticapps.net/
• https://wonderful-tree-09f1c2410-<GITHUB_PR_NUMBER>.centralus.2.azurestaticapps.net/

The production branch is automatically deployed to the following URL: https://dev.aireadi.org

Contributing

Contributions are always welcome!

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

For any developmental standards to follow, add them directly to the CONTRIBUTING.md file.

Issues and Feedback

To report any issues with the software, suggest improvements, or request a new feature, please open a new issue via the Issues tab. Provide adequate information (operating system, steps leading to error, screenshots) so we can help you efficiently.

License

This work is licensed under MIT. See LICENSE for more information.

How to cite

If you are using this software or reusing the source code from this repository for any purpose, please cite:

    ADD Citation here

Acknowledgements

This project is funded by the NIH under award number 1OT2OD032644. The content is solely the responsibility of the authors and does not necessarily represent the official views of the NIH.

Add any other acknowledgements here.

---