Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramprasathmk/poet-app
A simple poet posting web app, runs on the localhost.
https://github.com/ramprasathmk/poet-app
ejs-express ejs-templates express-app express-js mongoose mongoose-schema nodejs poet-app quote-app quote-publisher
Last synced: 23 days ago
JSON representation
A simple poet posting web app, runs on the localhost.
- Host: GitHub
- URL: https://github.com/ramprasathmk/poet-app
- Owner: ramprasathmk
- Created: 2024-11-18T16:57:49.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-04T12:47:26.000Z (30 days ago)
- Last Synced: 2024-12-04T13:41:06.713Z (30 days ago)
- Topics: ejs-express, ejs-templates, express-app, express-js, mongoose, mongoose-schema, nodejs, poet-app, quote-app, quote-publisher
- Language: EJS
- Homepage: https://poet-app.onrender.com
- Size: 1.23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quote | Poem Posting Web Application
## Description
A simple web application that allows users to post, edit, and delete quotes. The application is built using Node.js and MongoDB.
## Features
- Post new quotes
- Edit existing quotes
- Delete quotes
- View all posted quotes
## Project Structure
- refer the Project Structure [here](./PROJECT_STRUCTURE.md).
## Setup
1. **Clone the repository:**
```bash
git clone https://github.com/ramprasathmk/poet-app.git
cd poet-app
```
2. **Install dependencies:**
```bash
npm install
```
3. **Start MongoDB:** Ensure MongoDB is running locally. If you're using a local installation, start MongoDB with:
```bash
mongod
```
4. **Start the application:**
```bash
nodemon server.js
```
otherwise, simply run the below **npm** command.
```bash
npm start
```
5. **Build the application:** build the application and run the production build.
```bash
npm run build
```
```bash
npm run dev
```
6. **Pack the application:** packs application into `appname-version.tgz` file.
```bash
npm pack
```
7. **Access the application:** Open your browser and navigate to http://localhost:3000
## Note
> - Create a `.env` file
> - Enter your port number, eg. PORT=3000
> - Then, enter your mongodb url, eg. MONGODB_LOCAL_URL=mongodb://127.0.0.1:27017/your_database_name
> - Here `db_name` would be varied, so kindly use the same db_name for the whole project.
## Sample Code:
1. `.env` file:
```text
PORT=3000
MONGODB_LOCAL_URL=mongodb://127.0.0.1:27017/quotes_db
```
## 👇 Poet App is Deployed here
- [Poet App](https://poet-app.onrender.com)
## Usage
- Navigate to the home page to view all quotes.
- Use the form to add a new quote.
- Click "Edit" to modify an existing quote.
- Click "Delete" to remove a quote.
## Technologies Used
- Bootstrap CSS
- Node.js
- Express.js
- MongoDB
- Mongoose
- EJS (Embedded JavaScript templates)
## Contributing
Feel free to modify this template to better suit your project’s specific needs. If you need further customization or have any questions, let me know!