Skip to content

Latest commit

 

History

History
105 lines (80 loc) · 2.31 KB

Setup.md

File metadata and controls

105 lines (80 loc) · 2.31 KB
Raw

Get Started

Prerequisites

Setup using GitHub

Clone the Repository

git clone https://github.com/Auto-DL/Auto-DL.git

Setup the .env file

Clone the sample.env to create .env in both BackEndApp/ and FrontEndApp/v1-react/ and configure the necessary environment variables

Getting the .env File

  • Auto-DL team has created an environment file for its contributers.
  • Download the file and paste it in Auto-DL/BackEndApp directory.
  • NOTE: Make sure the name of the file is .env (that " . " is important)

Installing the Requirements and Running the App

Windows
For Backend 
cd Auto-DL/BackEndApp
pip install -r requirements.txt

For Frontend

cd Auto-DL/FrontEndApp
npm install

Only after all requriements from requirements.txt are installed

cd BackEndApp
mkdir logs

Run the Backend

python manage.py runserver
# you can ignore any migration warnings

Finally, run the react frontend

# on a new terminal tab
cd FrontEndApp/v1-react
npm start
Linux 
cd Auto-DL

sudo ./scripts/install.sh

sudo ./scripts/run.sh
MacOS 
cd Auto-DL

brew ./scripts/install.sh

brew ./scripts/run.sh

Setup using Docker

Configure the necessary environment variables in docker-compose.yml and run docker-compose up.
This will setup a development server, so instead if you want to setup a production server you can replace the dockerfile context in docker-compose.yml for each container to include the production Dockerfile instead of Dockerfile.dev.

Note: Before running the production docker containers modify the nginx configuration if needed in nginx/nginx.conf as the FrontEndApp docker container uses nginx in production