This is a Next.js project bootstrapped with create-next-app.
First, run the development server:
yarn dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.
This repository (fe) is the Next.js Progressive Web App (PWA) for Need4Deed, automating and supporting our platform’s business processes.
It is actively developed and will eventually include our public landing page (currently hosted separately).
| Repository | Description |
|---|---|
backend |
Node.js / TypeScript API backend |
sdk |
Shared TypeScript types and helpers used by FE and BE |
website |
Legacy React/Vite landing page (currently frozen) |
The FE, BE, and SDK are designed to work together locally in a sibling-folder setup:
parent/
├── fe/ # Frontend (Next.js app)
├── be/ # Backend (API)
└── sdk/ # Shared TypeScript SDK
NEXT_PUBLIC_CLOUDFRONT_URL=https://d2nwrdddg8skub.cloudfront.net/images NEXT_PUBLIC_CLOUDFRONT_DATA_URL=https://d2nwrdddg8skub.cloudfront.net/data
Make sure you have all three repos cloned in the same parent directory:
git clone https://github.com/need4deed-org/fe.git
git clone https://github.com/need4deed-org/be.git
git clone https://github.com/need4deed-org/sdk.gitThe sdk repo contains the API types that are used by be and fe. These are published as an npm package need4deed-sdk. The following points must be considered before modifying these types.
-
Modifying the API types in
sdkmust be followed by republishing theneed4deed-sdkpackage to the npm registry. https://www.npmjs.com/package/need4deed-sdk -
The
fe,beandsdkshould then be upgraded using the following command.
yarn upgrade need4deed-sdk --latest- Linking the
sdklocally will result in updated package references in thepackage.jsonfile which will diverge from the published stable version of theneed4deed-sdkThis may result in production failures and is best avoided. - Using local type definitions and other workarounds is not acceptable.
All designs and layouts are defined in Figma. Before implementing or modifying any UI component:
- Follow the design from the official Figma project shared by the Need4Deed design team
- Match typography, spacing, and component structure
- Discuss any changes or deviations with the design team before merging
Keeping the FE aligned with Figma ensures consistency and quality across our app.
- You can manually open the specific page you’re working on via its local URL (e.g.
http://localhost:3000/dashboard) - The FE app will gradually incorporate the public landing page currently hosted on Amplify/S3
- The
websiterepo is frozen until the merge into this app is complete
We welcome all contributions — from bug fixes to feature development.
-
Fork this repository
-
Clone your fork
-
Create a new branch
git checkout -b your_nick-feature-name
-
Commit your changes Follow our commit message style guide:
- Use present tense (“Add feature” not “Added feature”)
- Use imperative mood (“Fix bug” not “Fixes bug”)
- Keep it short (under 72 chars)
- Prefix with an emoji when relevant:
- 🎨 — style/format improvements
- 🐛 — bug fix
- 📝 — docs
- 🔥 — removing code/files
-
Push your branch and open a Pull Request to
main -
Tag a maintainer for review (
@arturas, etc.)
- Use the Issues tab in this repository
- Check existing issues before opening a new one
- Use the provided templates for bug reports and feature requests
By contributing, you agree that your contributions are licensed under our Commons Clause + MIT License.