Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cybermaxi7/nextjs-news-app
https://github.com/cybermaxi7/nextjs-news-app
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/cybermaxi7/nextjs-news-app
- Owner: Cybermaxi7
- Created: 2024-03-01T11:42:21.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-03T20:08:25.000Z (10 months ago)
- Last Synced: 2024-03-03T21:24:04.287Z (10 months ago)
- Language: TypeScript
- Homepage: https://nextjs-news-app-smoky.vercel.app
- Size: 93.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Cybermaxi News App
This is a Next.js 14 application built with TypeScript, Tailwind CSS, GraphQL (using StepZen), and React Timeago to display news articles.
### Features
* **Dynamic News Feed:** Fetches news articles from various sources using StepZen.
* **Categories and Keywords:** Filter news by categories and keywords.
* **Dark Mode:** Toggle between light and dark themes.
* **Timeago:** Displays time since article publication using React Timeago.
### Installation
1. Clone this repository.
2. Install dependencies:
```bash
npm install
```
### Usage
1. **Set up your StepZen API:**
- Create a StepZen account and obtain your API key.
- Configure StepZen to connect to your desired news API.
2. **Set environment variables:**
- Create a `.env.local` file at the root of the project.
- Add the following variables with your values:
```
NEXT_PUBLIC_STEPZEN_API_KEY=
```
3. **Run the application:**
```bash
npm run dev
```
This will start the development server and open the app in your browser at http://localhost:3000.
### Technologies
* **Next.js:** Server-side rendering framework
* **TypeScript:** Superset of JavaScript for type safety
* **Tailwind CSS:** Utility-first CSS framework
* **GraphQL:** Data query language
* **StepZen:** GraphQL management platform
* **React Timeago:** React component for displaying relative time
### Deployment
You can deploy this application to any platform that supports Next.js applications, such as Vercel, Netlify, or AWS Amplify. Follow the deployment instructions specific to your chosen platform.
### Contributing
Pull requests are welcome. Please follow the standard Git workflow and ensure your code adheres to the project's style and formatting guidelines.
### License
This project is licensed under the MIT License. See the `LICENSE` file for details.
### Disclaimer
This is a basic structure for a README file. You may need to add additional information specific to your project, such as:
* Detailed setup instructions for StepZen
* Contribution guidelines
* Screenshots or a demo link
* Contact information