aireadi.org

Website of the AI-READI project

Documentation · Changelog · Report Bug · Request Feature

Description

This repository contains the source code of the AI-READI website. The website is built with Next.js, a React framework for static and server-rendered applications.

Getting started

⚠️ Prerequisites

This project uses Yarn as package manager.

Requirements

• Node.js >= 12.22.0
• Yarn 1 (Classic)

sh npm install --global yarn

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

sh conda install -c conda-forge yarn nodejs

Run locally

Clone the project

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

Go to the project directory

sh cd aireadi.org

Install dependencies

sh yarn install

Start the server

sh yarn dev

Build locally

Use this step to build a local production version of the site. Use start to preview the local build.

bash yarn build yarn start

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://yellow-mud-0c2b16f10-<BRANCH_NAME.centralus.2.azurestaticapps.net/>
• https://yellow-mud-0c2b16f10-<GITHUB_PR_NUMBER.centralus.2.azurestaticapps.net/>

Note: All punctuation in the branch name will be removed when creating the URL.

The production branch is automatically deployed to the following URL: https://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.

We recommend to look at the documentation.

Directory Structure

• .github — GitHub configuration including the CI workflow.
  
• .husky — Husky configuration and hooks.
  
• public — Static assets such as robots.txt, images, and favicon.
  
• src — Application source code, including pages, components, styles.
• cypress — End-to-end tests.

Scripts

• yarn dev — Starts the application in development mode at http://localhost:3000.
• yarn build — Creates an optimized production build of your application.
• yarn start — Starts the application in production mode.
• yarn type-check — Validate code using TypeScript compiler.
• yarn lint — Runs ESLint for all files in the src directory.
• yarn format — Runs Prettier for all files in the src directory.
• yarn cypress:run — Runs Cypress tests in headless mode.
• yarn cypress:open — Opens Cypress in interactive mode.

Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the @ prefix.

```tsx import { Button } from '@/components/Button';

// To import images or other files from the public folder import avatar from '@/public/avatar.png'; ```

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.

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.