Skip to content

getting-started.md

Latest commit

 

History

History
53 lines (36 loc) · 1.23 KB

getting-started.md

File metadata and controls

53 lines (36 loc) · 1.23 KB

🏁 Getting Started (Manual Setup)

This guide will walk you through setting up DVinyl on your local machine or server using Node.js and MongoDB.

📋 Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v18.x or higher)
  • npm or yarn
  • MongoDB (v6.x or higher)

🛠️ Installation Steps

1. Clone the Repository

git clone https://github.com/Kyonew/DVinyl.git
cd dvinyl

2. Install Dependencies

npm install

3. Configure Environment Variables

Copy the template and fill in your details (see API Configuration for keys):

cp .env.example .env

Important

Make sure to use PROD=true ONLY WITH HTTPS. For localhost or local IP access, leave PROD to false. For the environment variables PASSJWT and SESSION_SECRET, make sure to use different complex passwords. They are essential for properly encrypting sessions.

4. Launch the Application

npm start app.js

You can also run the app with pm2:

pm2 start app.js --name dvinyl

DVinyl should now be running at http://localhost:3099.

← Back to README
See Docker installation →