https://github.com/potlock/curate-feed-template
https://github.com/potlock/curate-feed-template
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/potlock/curate-feed-template
- Owner: PotLock
- Created: 2025-02-24T14:47:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-12T04:21:23.000Z (about 1 year ago)
- Last Synced: 2025-03-12T05:23:54.127Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://solweek-feed.vercel.app
- Size: 1.19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Twitter Filtered Feed
## Setup and Installation
To run this project locally, you'll need [Node.js](https://nodejs.org) and [pnpm](https://pnpm.io) installed on your system.
```sh
# Install pnpm if you haven't already
npm install -g pnpm
# Clone the repository
git clone
# Navigate to project directory
cd solana-digest
# Install dependencies
pnpm install
# Start development server
pnpm dev
```
## Tech Stack
- Vite
- TypeScript
- React
- shadcn-ui
- Tailwind CSS
## Development
The development server will start at `http://localhost:8080` by default. The app will automatically reload if you change any of the source files.
```sh
pnpm dev
```
## Building for Production
```sh
pnpm build
```
## Project Configuration Instructions
This project is designed to be easily configurable for different feeds, themes, and metadata. Follow the steps below to customize the application according to your needs.
### 1. Configuration File
The main configuration settings are stored in the `src/config.ts` file. You can modify the following properties:
```typescript
const config = {
appTitle: "Your App Title", // Title of your application
appDescription: "A brief description of your app.", // Description for SEO
keywords: "keyword1, keyword2, keyword3", // Keywords for SEO
author: "Your Name", // Author of the application
ogImage: "URL to your image", // Open Graph image URL
ogUrl: "https://yourapp.com", // Open Graph URL
colors: {
primary: "#14F195", // Primary color for the theme
secondary: "#9945FF", // Secondary color for the theme
background: "#000000", // Background color
text: "#FFFFFF", // Text color
},
};
```
### 2. Using the Configuration
The configuration is accessible throughout the application using the `ConfigContext`. This allows you to use the configuration values in any component.
#### Example Usage in a Component
To use the configuration in a component, import the `useConfig` hook:
```typescript
import { useConfig } from "../ConfigContext";
const MyComponent = () => {
const config = useConfig(); // Get the config
return (
{config.appTitle}
{config.appDescription}
);
};
```
### 3. Updating Metadata
The metadata for the application is set in the `src/App.tsx` file using the `react-helmet` library. You can modify the metadata as follows:
```typescript
{config.appTitle}
```
### 4. Theming
You can easily change the colors used in the application by modifying the `colors` object in the `src/config.ts` file. This will allow you to create different themes for your application.
## Conclusion
By following these instructions, you can easily customize the application to fit your project's needs. Feel free to modify the configuration file to suit your requirements.