Installation_guide

Installation guide to run Cosmos-Search locally

The average time to setup Cosmos-Search locally has been reported to be 🚄 2 minutes. Follow the following steps to get started instantly:

Clone this wonderful repository in your local machine 🖥️ :

$ git clone https://github.com/OpenGenus/cosmos-search.git

Go inside code 🏡 :
```
$ cd cosmos-search
```
Setup a virtual environment 🏘️ :

$ virtualenv -m python3 env_name OR $ python3 -m venv env_name
Activate the virtual environment 🌀 :
```
$ source env_name/bin/activate
```
The virtual environment can be deactivated with the deactivate command.
Install local dependencies 🛠️ :
```
 pip install -r requirements.txt
```
Copy the .env.example file to .env and supply values for the required variables using the following command 🏃‍♂️ :
```
  cp .env.example .env
```
Collect static files using 📚 :
```
$ python manage.py collectstatic
```
Migrating files using 📨 :
```
$ python manage.py migrate
```
Run Cosmos-Search 🚗 :
```
$ python manage.py runserver
```
View this wonderful search engine built for you 😍 :
```
localhost:8000
```

To run the web app in Debug mode set the DEBUG environment variable. In Linux, run the export DEBUG=True command in the terminal.

Get in touch with us at Slack or ask us at our Discourse forum.