Poet App

Poet App is a simple web application that allows users to post, edit, and delete quotes or poems. Built using Express.js and MongoDB, it provides a straightforward interface for managing literary entries.

Note !

• CI Status keeps failing due to revoke of the hosting.

Table of Contents

• Poet App
  • Note !
  • Table of Contents
  • Features
  • Prerequisites
  • Installation
  • Usage
  • Project Structure
  • Contributing
  • Thank You

Features

• Post Quotes/Poems: Add new literary entries to the collection.
• Edit Entries: Modify existing quotes or poems.
• Delete Entries: Remove entries from the collection.
• View All Entries: Browse through all posted quotes and poems.

Prerequisites

Before you begin, ensure you have the following tools installed:

• Node.js: >= 20.10.0
• MongoDB Compass: >= 7.x
• Visual Studio Code: latest

Installation

1. Clone the Repository:

   git clone https://github.com/ramprasathmk/poet-app.git

2. Navigate to the Project Directory:

   cd poet-app

3. Install Dependencies:

   npm install

Usage

1. Create .env file in the root directory:

   Your .env file must have those configs to up the server.

   PORT=
   MONGODB_URI=
   NODE_ENV=

2. Start the Application:

   npm start

3. Access the Application:

   Open your browser and navigate to http://localhost:3000 to start using the Poet App.

Project Structure

The project follows a standard MVC (Model-View-Controller) architecture:

• controllers/: Contains the logic for handling requests and responses.
• models/: Defines the data schemas and interacts with the database.
• routes/: Manages the routing of HTTP requests.
• views/: Holds the EJS templates for rendering the frontend.
• public/: Includes static assets like CSS and JavaScript files.

Contributing

Contributions are welcome! If you have suggestions or improvements, please fork the repository and submit a pull request.

---

Thank You

Thank you for using Poet App! Feel free to support, explore, contribute, and share your thoughts.