Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 2.42 KB

README.md

File metadata and controls

65 lines (47 loc) · 2.42 KB
Raw

OurApp

Introduction 📌

A Social blogging site connecting people based on their personal interest in specific genre where they can endlessly explore mostrelevant topics based on their search plus can also follow converse with author(s) of theirfavorite blogs.

Technology Stack 🏁

  • Express - Fast, unopinionated, minimalist web framework for Node.js
  • MongoDB - Document database for modern applications
  • EJS - Embedded JavaScript templating engine
  • Nodemon - Monitor for any changes in your application and automatically restart the server

Installation💥

To get started with [Project Name], follow these steps:

  1. Clone the repository to your local machine using the following command:
git clone https://github.com/Narcos101/OurApp.git
  1. Change into the project directory:
cd ourApp
  1. Install the required dependencies by running the following command:
npm install
  1. Set up the MongoDB database:
  • Ensure that MongoDB is installed and running on your machine.
  • Create a new MongoDB database.
  • Update the database configuration in db.js to point to your MongoDB database.
  1. Start the application in development mode by running the following command:
npm run dev
  1. Access the application by navigating to http://localhost:3000 in your web browser.

Usage

Here's a brief overview of the project structure:

  • app.js: The main entry point of the application.
  • router.js: Contains the route definitions for different application endpoints.
  • models/: Contains the MongoDB models for data schema.
  • views/: Contains the EJS templates for rendering dynamic web pages.
  • public/: Contains static assets such as CSS stylesheets and client-side JavaScript files.

Application Preview 👀

image

For contributors

  • Before contributing do go through the Code of Conduct and the Contributors Guidelines.
  • If you find any bug in the application, or a feature you think would be nice to have, please open an issue.
  • If you want to contribute code, please fork the project and submit a pull request.

LICENSE 📜

MIT