Woolify backend

Project Setup Guide

Prerequisites

• Node.js
• MongoDB
• Postman

Getting Started

1. Clone the repository:

   git clone https://github.com/Woolify/backend.git
   

   OR

   git clone [email protected]:Woolify/backend.git
   

2. Install dependencies:

   npm install
   

Configuration

1. Copy config/config.env.sample to config/config.env:

   cp config/config.env.sample config/config.env
   

2. Edit config/config.env with your settings:

   PORT=8000
   MONGO_URI=mongodb_connection_uri
   JWT_SECRET=your_secret_key
   SMTP_HOST=smtp_credentials_from_mail_test
   YOUTUBE_API_KEY=if_using_yt_streams
   VIMEO_ACCESS_TOKEN=if_using_vimeo
   

Database Setup

1. Ensure MongoDB is running.

2. Verify the MongoDB connection in config/database.js.

Running the App

• Development Mode (with auto-reloading):

  npm run dev
  

• Production Mode:

  npm start
  

The app will run on http://localhost:8000 (or your specified port).

Usage

Start building your Node.js Express project with MongoDB as the database.

Note

• Keep config.env secure; never commit it to public repos.
• Delete or clear logs/access.log before pushing code to prod.

License

MIT License