Skip to content

vj-abishek/news-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6687619 Β· May 24, 2023

History

90 Commits
Nov 19, 2022
Nov 19, 2022
May 24, 2023
Dec 10, 2022
May 24, 2023
Dec 12, 2022
Nov 7, 2022
Dec 19, 2022
Dec 10, 2022
Nov 13, 2022
Nov 19, 2022
Nov 7, 2022
Nov 13, 2022
Dec 10, 2022
Nov 13, 2022
Nov 19, 2022
Nov 19, 2022
May 24, 2023
Nov 19, 2022
Nov 19, 2022
May 24, 2023
Dec 10, 2022
May 23, 2023
May 23, 2023
Nov 7, 2022
Nov 13, 2022
Nov 19, 2022

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