Merge pull request #19 from nmbazima/codespace-super-space-dollop-vpx66qj5qxr3pqr9

Pending changes exported from your codespace

Author: nmbazima

article-management-project/README.md

@@ -0,0 +1,65 @@
+# Article Management Project
+
+This project provides a simple and scalable way to manage articles and organize them by categories. Below are the instructions on how to post articles and utilize the category management features.
+
+## Table of Contents
+- [Getting Started](#getting-started)
+- [Posting an Article](#posting-an-article)
+- [Organizing Articles by Category](#organizing-articles-by-category)
+- [Project Structure](#project-structure)
+
+## Getting Started
+
+To get started with the Article Management Project, clone the repository and install the necessary dependencies.
+
+```bash
+git clone <repository-url>
+cd article-management-project
+npm install
+```
+
+## Posting an Article
+
+1. Navigate to the `src/articles` directory.
+2. Create a new Markdown file for your article. Use the naming convention `article-title.md` (e.g., `my-first-article.md`).
+3. Structure your article using Markdown syntax. Here’s a basic template:
+
+   ```markdown
+   # Article Title
+
+   ## Introduction
+   Write an introduction here.
+
+   ## Content
+   Write the main content of your article here.
+
+   ## Conclusion
+   Write a conclusion here.
+   ```
+
+4. Save the file. Your article will now be available in the project.
+
+## Organizing Articles by Category
+
+1. To add a new category, open the `src/categories/index.ts` file.
+2. Use the `addCategory` method of the `CategoryManager` class to create a new category.
+3. Assign articles to categories using the `organizeArticlesByCategory` method.
+
+Example usage:
+
+```typescript
+const categoryManager = new CategoryManager();
+categoryManager.addCategory('Technology');
+categoryManager.organizeArticlesByCategory('Technology', 'my-first-article.md');
+```
+
+## Project Structure
+
+- `src/articles/`: Contains all article files in Markdown format.
+- `src/categories/`: Contains the `CategoryManager` class for managing categories.
+- `src/app.ts`: Entry point of the application.
+- `src/types/`: Contains TypeScript interfaces for articles and categories.
+- `package.json`: Lists dependencies and scripts for the project.
+- `tsconfig.json`: TypeScript configuration file.
+
+For further information, refer to the code comments in the respective files or consult the documentation of the libraries used.

article-management-project/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "article-management-project",
+  "version": "1.0.0",
+  "description": "A project for managing articles and organizing them by categories.",
+  "main": "src/app.ts",
+  "scripts": {
+    "start": "ts-node src/app.ts",
+    "build": "tsc",
+    "test": "echo \"No tests specified\" && exit 0"
+  },
+  "dependencies": {
+    "express": "^4.17.1",
+    "typescript": "^4.4.4"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.11",
+    "ts-node": "^10.4.0"
+  },
+  "author": "Your Name",
+  "license": "MIT"
+}

article-management-project/src/app.ts

@@ -0,0 +1,41 @@
+import express from 'express';
+import bodyParser from 'body-parser';
+import { CategoryManager } from './categories/index';
+import { Article } from './types/index';
+
+const app = express();
+const port = process.env.PORT || 3000;
+const categoryManager = new CategoryManager();
+
+app.use(bodyParser.json());
+
+// Endpoint to post a new article
+app.post('/articles', (req, res) => {
+    const article: Article = req.body;
+    // Logic to save the article
+    res.status(201).send('Article posted successfully');
+});
+
+// Endpoint to get articles by category
+app.get('/articles/:category', (req, res) => {
+    const category = req.params.category;
+    const articles = categoryManager.organizeArticlesByCategory(category);
+    res.status(200).json(articles);
+});
+
+// Endpoint to add a new category
+app.post('/categories', (req, res) => {
+    const categoryName = req.body.name;
+    categoryManager.addCategory(categoryName);
+    res.status(201).send('Category added successfully');
+});
+
+// Endpoint to get all categories
+app.get('/categories', (req, res) => {
+    const categories = categoryManager.getCategories();
+    res.status(200).json(categories);
+});
+
+app.listen(port, () => {
+    console.log(`Server is running on http://localhost:${port}`);
+});

article-management-project/src/articles/example-article.md

@@ -0,0 +1,37 @@
+# Markdown content for the example article
+
+# Example Article Title
+
+## Introduction
+
+This is an example article to demonstrate how to structure articles within the article management project. Articles are written in Markdown format, which allows for easy formatting and readability.
+
+## Content
+
+### Section 1: Overview
+
+In this section, you can provide an overview of the topic discussed in the article. Use headings, lists, and other Markdown features to organize your content effectively.
+
+### Section 2: Details
+
+Here, you can delve deeper into the subject matter. Include relevant information, statistics, or examples to support your points.
+
+- Bullet point 1
+- Bullet point 2
+- Bullet point 3
+
+### Conclusion
+
+Summarize the key points discussed in the article and provide any final thoughts or calls to action.
+
+## Categories
+
+- Example Category 1
+- Example Category 2
+
+## References
+
+1. Reference 1
+2. Reference 2
+
+This example serves as a template for creating new articles. Be sure to replace the content with your own and adjust the categories as needed.

article-management-project/src/categories/index.ts

@@ -0,0 +1,27 @@
+class CategoryManager {
+    private categories: string[] = [];
+    private articlesByCategory: { [key: string]: string[] } = {};
+
+    addCategory(category: string): void {
+        if (!this.categories.includes(category)) {
+            this.categories.push(category);
+            this.articlesByCategory[category] = [];
+        }
+    }
+
+    getCategories(): string[] {
+        return this.categories;
+    }
+
+    organizeArticlesByCategory(article: string, category: string): void {
+        if (this.categories.includes(category)) {
+            this.articlesByCategory[category].push(article);
+        } else {
+            throw new Error(`Category "${category}" does not exist.`);
+        }
+    }
+
+    getArticlesByCategory(category: string): string[] {
+        return this.articlesByCategory[category] || [];
+    }
+}

article-management-project/src/types/index.ts

@@ -0,0 +1,14 @@
+export interface Article {
+    id: string;
+    title: string;
+    content: string;
+    categoryId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+export interface Category {
+    id: string;
+    name: string;
+    description?: string;
+}

article-management-project/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist"
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/*.spec.ts"
+  ]
+}