Skip to content

vj-abishek/news-app

Repository files navigation

The Print 📜 news app

GitHub stars GitHub contributors GitHub issues

The privacy focused news app made for ibm cloud

Screenshot from 2022-11-19 12-01-33

This live version of the app can be found in theprint.me

Features

  • News at your finger tips
  • Sleek UI
  • Light weight app
  • Bookmark your news and get back to it later
  • Automagic regional news
  • Select news based on topic
  • Change language any time

Team members

Technologies used

Folder structure

├── backend
│   ├── Dockerfile
│   ├── kubernetes
│   │   └── config.yaml
│   ├── requirements.txt
│   ├── server.py
│   └── wsgi.py
├── components
│   ├── bottomNav.tsx
├── pages
│   ├── api
│   │   ├── auth
│   │   │   └── [...nextauth].js
│   │   ├── headlines.ts
│   │   ├── next.ts
│   │   └── proxy.ts
│   ├── _app.tsx
│   ├── bookmarks.tsx
│   └── index.tsx
├── styles
      └── globals.css
  • backend - Consists of the flask server
  • backend/kubernetes - Kubernetes config file (Deployment, Service ,Ingress)
  • components - Components for the frontend
  • pages - File based routing
  • pages/api - The api route for the frontend (headlines, next - pagination, proxy - for the server)
  • pages/auth - The route used for authentication
  • styles - The global styles for the app

Frotend setup

  • Install node js - Node js
  • Add necessary values in the env - Sample env
  • To install dependency - npm install

To run the developmen server:

npm run dev
# or
yarn dev

Backend setup

  • Install python - Python Installation
  • Install dependency - python -m pip install -r requirements.txt
  • To run the app - python server.py

Screenshots

Copyright

Licensed under the GNU General Public License v2.0