Coder Social home page Coder Social logo

news-feed's Introduction

Setting up the project

First step is to set .env file in app root with current values:

SASS_PATH=./node_modules;./src
HTTPS=true
PORT=8443
REACT_APP_API_KEY=ENTER_YOUR_API_KEY_HEY_HERE

PORT is optional REACT_APP_API_KEY can be obtained from newsapi.org

Setting dark theme

The application has both a dark and light web theme. Switch within the user interface is left as TODO, but it can be manually selected in index.html by changing::

<body class="theme-light"> to <body class="theme-dark">

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open https://localhost:8443 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

yarn lint

Performs lint check. Lint rules are defined in the github repo dcoric/eslint-config-groundlink

Caching is enabled by default so next lint checking are only running across modified files.

yarn lint-fix

This will run check as in yarn lint but will auto-fix most of the minor issues like spacings, new lines, missing ;...

yarn storybook

Starts storybook with components preview

yarn build-storybook

Build storybook as independent application which can be deployed

API Connections

For communication with external API, axios is used. Since newsapi.org does not have CORS setting allowed for localhost/development, it is bypassed by using the proxy server: cors-anywhere.herokuapp.com

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.