Website of the AI-READI project
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.
This project uses pnpm as package manager and mise to manage tool versions.
mise- Node.js and pnpm (installed via mise)
mise install
mise useIf you do not want to use mise, install Node.js and pnpm manually:
npm install --global pnpmClone the project
https://github.com/AI-READI/aireadi.org.gitGo to the project directory
cd aireadi.orgInstall dependencies
pnpm installStart the server
pnpm devUse this step to build a local production version of the site. Use start to preview the local build.
pnpm build
pnpm startThis 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
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.
.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.
pnpm dev— Starts the application in development mode athttp://localhost:3000.pnpm build— Creates an optimized production build of your application.pnpm start— Starts the application in production mode.pnpm typecheck— Validate code using TypeScript compiler.pnpm lint— Runs ESLint for all files in thesrcdirectory.pnpm format— Runs Prettier for all files in thesrcdirectory.pnpm cypress:run— Runs Cypress tests in headless mode.pnpm cypress:open— Opens Cypress in interactive mode.
TypeScript are pre-configured with custom path mappings. To import components or files, use the @ prefix.
import { Button } from '@/components/Button';
// To import images or other files from the public folder
import avatar from '@/public/avatar.png';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.
This work is licensed under MIT. See LICENSE for more information.
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.
