Git Product home page Git Product logo

shirkocurek / newsflowhub Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 4.54 MB

A full stack Live News app using the MediaStack API. Built using Type Script, React, Next.js, Tailwind and a GraphQL API. Static and dynamic rendering fully responsive and includes advance UI features like dark mode and next loading component.

Home Page: https://news-flow-hub.vercel.app

CSS 3.54% TypeScript 94.66% JavaScript 1.80%

newsflowhub's Introduction

Welcome to NewsFlowHub

newsflowhub

A full stack Live News app using the MediaStack API. Built using TypeScript, React, Next.js, Tailwind and a GraphQL API. Static and dynamic rendering fully responsive and includes advance UI features like dark mode and next loading component.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Tier 1 - MVP application - Index page (or Home page) with Styled Components (CSS Framework) ✔️

Fetch a list of things and display them nicely using a CSS Framework of styled Components.

As a user, I want to see the data nicely organized, so that I can consume and interact with it.

As a user, I want the app to have a nice UX, so that I can be happy and enjoy my time using the app.

Tier 2 - Client-Side Routing ✔️

Implement routing to access different pages in the application. It’s ok if there’s no Nav bar yet, that can be handled in a later tier

As a user, I want to see the URL change as I move through different parts of the application, so that I can bookmark my favorite page and share it with friends.

As a user, I want the app to be dynamic and interactive, so that I can enjoy my time using the app.

As a user, I want the app to dynamically and quickly swap the content out on the page when I’m navigating to another section of the app, so that the page doesn’t refresh and it feels like a better and faster experience.

Tier 3 - Dynamic Routes - Show Page ✔️

Add nested routes using query params e.g. /cats/:name and render a Show page (or, details page, etc.) about that specific queried thing. (i.e. /cats/fluffykins should show all the details about the cat named fluffykins).

As a user, I want to view details about a single thing, so that I can learn more about it.

As a user, I want the URL to change to include the thing I’m looking at, so that I can bookmark the page and share it with friends.

Tier 4 - Global State & Search/Filter ✔️

Store some data globally in state (i.e. context) and share it between multiple components. i.e. user enters input in one component and the value from the input is used elsewhere to filter a list. This is purely a “behind-the-scenes” piece of functionality, and it’s difficult to write a user story for how this works, but here’s an example of how that could work.

As a user entering a value in an input, I want the list of things to be filtered based on the value I entered.

Tier 5 - Navigation (Nav Bar) ✔️

Since we should already have multiple routes and navigation functionality, let’s add an app-wide Nav bar to connect those routes.

As a user, I want to see a convenient and user-friendly Nav bar, so that I can easily navigate my way around the app.

Tier 6 - Accessibility ✔️

Using the Lighthouse feature of Chrome-based browsers, verify your Accessibility is in the Green!

Bonus Goals ✔️

Implement a Theme & Dark Mode toggle switch to allow users to customize the look of the app.

Deployment ✔️

-Deploy the application using the service of your choice.

-Tier 2 - Deployed Application via Continuous Deployment

-Set up continuous deployments so that the application is deployed upon push/merge to main (or some other trigger).

-Main Goal: The deployed app should be the most up to date version of your working-and-tested repository code.

-Create a GitHub Workflow file for GitHub Actions and/or other necessary files for your deployment.

Technologies Used

React - A JavaScript library for building user interfaces

Next.js - Next.js is an open-source web development framework

Tailwind - A utility-first CSS framework

NodeJS -Javascript Runtime Environment

Github - For version control

Postman - Testing API calls for our DELETE, PUT, POST and GET.

newsflowhub's People

Contributors

shirkocurek avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.