News App

A simple news app that displays the latest news from the channel of your choice.

Table of Contents

• Features
  • Admin
  • Client
  • Api
• Technologies
• Getting Started
  • Prerequisites
  • Installation
    • Local Development
    • Docker Development
• Project Structure
• Scripts
• Testing
• Linting
• Formatting
• Api Documentation
• Contributing
• License

Features

Vue.js, Nest.js, Next.js,Lerna.js, MongoDB, Docker, Docker Compose, Nginx, Jest, Eslint, Prettier, Swagger

Admin

• Admin can create, update and delete news channels.
• Admin can create, update and delete news articles.
• Admin can view all news articles.
• Admin can view all news channels.
• Admin can view all news articles for a specific channel.
• Admin can view all news articles for a specific channel and category.
• Admin can view all news articles for a specific channel and date.
• Admin can view all news articles for a specific channel, category and date.
• Admin can view all news articles for a specific channel and date range.

Client

• Client can view all news articles.
• Client can view all news channels.
• Client can view all news articles for a specific channel.
• Client can view all news articles for a specific channel and category.
• Client can view all news articles for a specific channel and date.
• Client can view all news articles for a specific channel, category and date.
• Client can view all news articles for a specific channel and date range.
• Client can view all news articles for a specific channel and category.
• Client can view all news articles for a specific channel and date.
• Client can view all news articles for a specific channel, category and date.
• Client can view all news articles for a specific channel and date range.
• Client can view all news articles for a specific channel and category.

Api

• Api can create, update and delete news channels.
• Api can create, update and delete news articles.
• Api can view all news articles.
• Api can view all news channels.
• Api can view all news articles for a specific channel.
• Api can view all news articles for a specific channel and category.
• Api can view all news articles for a specific channel and date.
• Api can view all news articles for a specific channel, category and date.
• Api can view all news articles for a specific channel and date range.

Technologies

• Lerna.js - A tool for managing JavaScript projects with multiple packages.
• Vue.js - The Progressive JavaScript Framework
• Nest.js - A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
• Next.js - The React Framework for Production
• MongoDB - The most popular database for modern apps
• Docker - Build, Share, and Run Any App, Anywhere
• Docker Compose - Compose is a tool for defining and running multi-container Docker applications.
• Nginx - The Fastest Web Server and Application Server
• Jest - Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
• Eslint - Find and fix problems in your JavaScript code.
• Prettier - An opinionated code formatter.
• Swagger - Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset.
• Git - Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.

Getting Started

Prerequisites

• Local Development
  • Node.js - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • MongoDB - The most popular database for modern apps
• Docker Development
  • Docker - Build, Share, and Run Any App, Anywhere
  • Docker Compose - Compose is a tool for defining and running multi-container Docker applications.

Installation

Local Development

1. Clone the repository

git clone git@github.com:oburakergen/news-workspace.git

2. Install dependencies

cd news-app
npm install

3. Create a .env file in the root directory of the project and add the following environment variables

# .env
MONGODB_URI=mongodb://localhost:27017/news-app

4. Start the server

npm run dev

Docker Development

1. Clone the repository

git clone git@github.com:oburakergen/news-workspace.git

2. Create a .env file in the root directory of the project and add the following environment variables

# .env
MONGODB_URI=mongodb://mongo:27017/news-app

3. Start the server

docker-compose up