This repository serves as a directory of all RISE apps, tools, and infrastructure that will be displayed on the RISE website.
-
Fork this repository and create a new branch for your addition.
-
Add your project logo and banner images:
- Create a directory for your project:
projects/your-project-name/ - Add a square logo (250x250px):
projects/your-project-name/logo.png - Add a banner image (1000x500px):
projects/your-project-name/banner.png
- Create a directory for your project:
-
Update the directory:
- Add your project to
src/directory.ts - Follow the existing format and provide all required fields
Example:
{ type: 'project', // Choose from: 'project', 'infrastructure', or 'tooling' name: 'Your Project Name', oneLiner: 'A short, catchy description (one sentence)', blurb: 'A detailed description of your project (max 150 words)', logo: '/projects/your-project-name/logo.png', banner: '/projects/your-project-name/banner.png', tags: ['crypto', 'payments'], // Choose from available tags in types.ts }
- Add your project to
-
Run tests to ensure everything works:
npm test -
Submit a pull request with your changes.
- Images must be in PNG format
- Logo must be 250x250px square
- Banner must be 1000x500px
- Blurb should be 150 words maximum
- All fields are required
- All tests must pass
# Install dependencies
npm install# Build the project
npm run buildThe compiled output will be in the dist directory.
# Run all tests
npm test
# Run tests in watch mode
npm run test:watch
# Run a specific test
npm test -- -t "test name"Important: All tests must pass before submitting a pull request. The CI pipeline will reject any PRs with failing tests.
# Run linter
npm run lintsrc/- TypeScript source codetypes.ts- Type definitions for projectsdirectory.ts- Project listings data__tests__/- Test files
projects/- Project assets (logos, banners)<project-name>/- Assets for each project
This repository uses GitHub Actions for continuous integration:
- Automatic Testing: Every pull request and push to main triggers automatic testing
- Build Verification: The CI pipeline ensures the project builds successfully
- Linting: Code style and quality are automatically checked
- Multiple Node Versions: Tests run on Node.js 18.x and 20.x
Once you submit your PR, the RISE team will review your submission. All CI checks must pass before a PR can be merged. We may request changes if necessary. After approval, your project will be added to the official RISE website directories.