Skip to content

Latest commit

 

History

History
108 lines (81 loc) · 4.66 KB

README.md

File metadata and controls

108 lines (81 loc) · 4.66 KB

💻 Inforeader

View Demo

Version GitHub CI Workflow Status GitHub repo size GitHub GitHub Repo stars Github repo views GitHub last commit

🚀 Getting Started

This is a web application that allows you to read technology news, using RSS feeds from different sources and saving them in a database. It also allows you to create a user account and save your favorite news.

📝 Requirements

  • Angular
  • Node
  • NPM
  • Git

Optional tools:

  • Visual Studio Code

📦 Installation & Usage

# Clone this repository
git clone https://github.com/marcode24/inforeader-frontend

# Go into the repository
cd inforeader-frontend

# Install dependencies
npm install

# Run the app
ng serve

shut it down manually with Ctrl-C or Cmd-C.

📐 Tests

# Run tests
npm run test

# Run tests with coverage
npm run test:cov

🌎 Environments

Name URL PORT
Localhost localhost 4200
Production https://inforeader.netlify.app/

📁 Folder Structure

.
├── src
│ ├── app                 # Source code application
│ │ │── auth              # Module for auth feature
│ │ ├── core              # Module as a singleton
│ │ │ ├── components
│ │ │ ├── constants
│ │ │ ├── guards
│ │ │ ├── interfaces
│ │ │ ├── models
│ │ │ ├── pipes
│ │ │ ├── services
│ │ │ └── utils
│ │ ├── features          # Module for features which compose the application
│ │ ├── shared            # Module for components shared between application modules
│ │ │ ├── components
│ ├── assets              # Styles, images, icons, fonts etc
│ ├── environments        # Config by environment (localhost and production)
│ └── styles              # Global styles
└── README.md

📝 License

This project is under the MIT license. See the LICENSE for more information. 😉

🖼️ Previews

Click to expand!

🖥️ Desktop

home-1 home-2 home-3 home-4

📱 Mobile

mobile-1 mobile-2 mobile-3 mobile-4