Skip to content

[UXIT][UXIT-2652] Update UXIT README (skip percy) #1494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apps/ff-site/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ This Next.js project is part of a monorepo managed by [Turborepo](https://turbor

### Useful commands

The following commands are specific to the `ff-site` workspace and should be run from the root of the monorepo.

| Command | Action |
| ------------------------------------------ | ----------------------------- |
| `npx turbo filecoin-foundation-site#dev` | Starts the development server |
Expand Down
2 changes: 2 additions & 0 deletions apps/ffdweb-site/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ This Next.js project is part of a monorepo managed by [Turborepo](https://turbor

### Useful commands

The following commands are specific to the `ffdweb-site` workspace and should be run from the root of the monorepo.

| Command | Action |
| --------------------------------------- | ----------------------------- |
| `npx turbo ffdweb-site#dev` | Starts the development server |
Expand Down
58 changes: 58 additions & 0 deletions apps/uxit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# User Experience Improvement Team (UXIT)

This project is the home of the [Filecoin Foundation](https://fil.org/) User Experience Improvement Team (UXIT), live at [uxit.fil.org](https://uxit.fil.org). UXIT is dedicated to creating thoughtful, user-centered solutions that drive the evolution of the Filecoin ecosystem.

## Getting Started

This Next.js project is part of a monorepo managed by [Turborepo](https://turborepo.com/docs). To get started, refer to the [root README](../../README.md#getting-started) for installation and development instructions.

### Useful commands

The following commands are specific to the `uxit` workspace and should be run from the root of the monorepo.

| Command | Action |
| -------------------------------- | ----------------------------- |
| `npx turbo uxit#dev` | Starts the development server |
| `npx turbo uxit#build` | Builds the application |
| `npx turbo uxit#start` | Starts the production server |
| `npx turbo uxit#lint` | Lints the code |
| `npm i <package> -w 'apps/uxit'` | Installs a dependency |

## Technologies

This project uses the following open-source technologies:

- [Next.js (App Router)](https://nextjs.org/) for server-side rendering, static site generation, and routing.
- [TypeScript](https://www.typescriptlang.org/) for static type checking.
- [Tailwind CSS](https://tailwindcss.com/) for utility-first CSS styling.
- [Unlighthouse](https://unlighthouse.dev/) for performance and accessibility audits.

## Lighthouse Reports

On [/site-audit-reports](https://uxit.fil.org/site-audit-reports), you will find [Lighthouse audit](https://developer.chrome.com/docs/lighthouse/overview) reports for an ever-growing list of Filecoin ecosystem projects, including Filecoin Foundation websites.

These reports are generated using [Unlighthouse](https://unlighthouse.dev/integrations/ci) and are stored in the `public/site-audit-reports` directory. They include performance metrics, accessibility scores, best practices analysis, and SEO recommendations.

Reports are currently NOT updated automatically. To update them, run the `generateSiteAuditReports` script in the `scripts` directory using:

```bash
npm run unlighthouse
```

Then commit the changes and push them to the repository.

## Development Guidelines

Check out the [development guidelines](../../README.md#development-guidelines) in the root README for more information.

## Contributing

We welcome contributions to the UXIT website!

### GitHub Workflow

We try to keep each pull request small and focused. If the work requires large file changes, we break it down into smaller pieces as outlined in this article on [GitHub Protips from Sarah Vessels](https://github.blog/developer-skills/github/github-protips-tips-tricks-hacks-and-secrets-from-sarah-vessels/).

## License

This project is licensed under the [Creative Commons Attribution 4.0 International license](https://creativecommons.org/licenses/by/4.0/).