Skip to content

Commit 927826c

Browse files
committed
remove 'Server Design', 'Data Models', Reactreferences
1 parent 1f6adb6 commit 927826c

File tree

1 file changed

+0
-28
lines changed

1 file changed

+0
-28
lines changed

README.md

-28
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ VoiceDeck is a platform that allows users to contribute retroactive funding for
1818

1919
- [TypeScript](https://www.typescriptlang.org/) programming language
2020
- [Next.js](https://nextjs.org/) full-stack framework
21-
- [React](https://react.dev/) frontend library
2221
- [TailwindCSS](https://tailwindcss.com/) css framework
2322
- [shadcn/ui](https://ui.shadcn.com/) ui components
2423
- [Directus](https://directus.io/) headless CMS / no-code data platform
@@ -33,32 +32,6 @@ VoiceDeck is a platform that allows users to contribute retroactive funding for
3332

3433
We recommend [direnv](https://direnv.net/) for managing your environment variables
3534

36-
## Data Models
37-
38-
- **Impact Report**: A report or story that has been previously published and verified to have produced an impact.
39-
- **Hypercert**: A token representing a claim of impactful work, which is fractionable and transferable. Conforms to the [ERC-1155](https://ethereum.org/en/developers/docs/standards/tokens/erc-1155/) standard for semi-fungible tokens.
40-
- **Hypercert Metadata**: A set of data associated with a Hypercert, stored on [IPFS](https://ipfs.tech/). Details the scope of work, contributors, verified impact, and ownership rights.
41-
42-
## Server Design
43-
44-
### Endpoint Details
45-
46-
`/impact-reports`
47-
48-
- **Returns**: An array of `Report` objects.
49-
- **Purpose**: To provide impact reports to the UI.
50-
- **Implementation Details**: Uses `fetchReports()` from `lib/impact-reports.ts`.
51-
52-
### Server Functions
53-
54-
Located in `app/server/impactReportHelpers.ts`:
55-
56-
- `fetchReports`: Function to retrieve reports, including interaction with Hypercerts.
57-
58-
### Separation of Concerns
59-
60-
The `/impact-reports` endpoint is responsible for serving impact reports. The implementation details of how the server retrieves data from Hypercert are abstracted away and managed within the `app/server/impactReportHelpers.ts` file.
61-
6235
## Getting Started
6336

6437
### Prerequisites
@@ -107,7 +80,6 @@ You can start editing the page by modifying `app/reports/page.tsx`.
10780
- [TypeScript Documentation](https://www.typescriptlang.org/docs/) TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
10881
- [Next.js Documentation](https://next.org/docs/) Next.js is a React framework for building full-stack web applications. You use React Components to build user interfaces, and Next.js for additional features and optimizations.
10982
Under the hood, Next.js also abstracts and automatically configures tooling needed for React, like bundling, compiling, and more. This allows focus on building the application instead of spending time with configuration.
110-
- [React Documentation](https://react.dev/reference/react/) React apps are made out of components. A component is a piece of the UI (user interface) that has its own logic and appearance. A component can be as small as a button, or as large as an entire page. React components are JavaScript functions that return markup.
11183
- [Tailwind Documentation](https://tailwindcss.com/docs/installation) Tailwind CSS is a utility-first CSS framework for rapidly building modern websites without ever leaving your HTML. A utility-first CSS framework packed with classes that can be composed to build any design, directly in your markup.
11284
- [Shadcn Documentation](https://ui.shadcn.com/docs) Shadcn provides beautifully designed components that you can copy and paste into your apps and enables you to bootstrap them via cli. It 5x's productivity and allows focus on what matters most, business logic + features.
11385
- [Directus Documentation](https://docs.directus.io/getting-started/introduction.html) Directus is an Open Data Platform built to democratize the database. It provides everyone on the team, regardless of technical skill, equal access to data and digital file asset management, for any data model or project. Directus enables you to perform CRUD operations, create users, assign roles with fully configurable permissions, build complex and granular queries, configure event-driven webhooks and task automation.

0 commit comments

Comments
 (0)