Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 2.14 KB

README.md

File metadata and controls

66 lines (47 loc) · 2.14 KB
Raw

SkyHome

SkyHome is a powerful and flexible network file storage solution that allows you to set up your own local server on your network for seamless file management and storage across your devices. With SkyHome, you can take control of your data and enjoy secure, accessible file storage within your home network.

Table of Contents

Pre-requisites

Installation

  1. Clone the repository:
git clone https://github.com/MrKrrot/skyhome.git
  1. Install dependencies:
npm install # Install server & client dependencies

  1. Set up environment variables:

    • In the api folder, create a .env file and provide the following environment variables:
    Variable Description
    DB_URI MongoDB database URI
    DB_URI_TEST MongoDB database URI for testing
    JWT_ACCESS_SECRET Secret key for JWT access token generation
    JWT_REFRESH_SECRET Secret key for JWT refresh token generation
    NODE_ENV Environment mode (development, production, etc.)
    PORT Port number for the API server (e.g., 5000)
    • In the client folder, create a .env file and provide the following environment variable:
    Variable Description
    REACT_API_URL API URL for the client-server interaction

Usage

# Build client & server
npm run build:client
npm run build:server
# Run server & client (production mode)
npm run start:server
npm run start:client

Development

# Run server & client (development mode)
npm run dev:server
npm run dev:client