Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Bhupesh-V committed Jul 24, 2019
1 parent 90582d9 commit 64c6507
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 9 deletions.
44 changes: 36 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
# tutorialdb
> A search engine for programming/dev tutorials.
## Installation
[![CodeFactor](https://www.codefactor.io/repository/github/bhupesh-v/tutorialdb/badge)](https://www.codefactor.io/repository/github/bhupesh-v/tutorialdb)

1. Clone the repository.
## Installation 🔮

```bash
git clone https://github.com/Bhupesh-V/tutorialdb.git
```

2. Create virtual environment.
1. Create virtual environment.

**Linux:**
```bash
Expand All @@ -19,6 +15,12 @@ virtualenv -p python3 venv && cd venv && source bin/activate
**Windows:**
```batch
python -m venv venv && venv\Scripts\activate.bat
```

2. Clone the repository.

```bash
git clone https://github.com/Bhupesh-V/tutorialdb.git
```

3. Install dependencies.
Expand All @@ -37,4 +39,30 @@ python manage.py migrate

```bash
python manage.py runserver
```
```
> For SECRET_KEY, follow below steps :
1. Run `python manage.py shell`
2. Do
```python
>>> from django.core.management.utils import get_random_secret_key
>>> get_random_secret_key()
'[GENERATED KEY]'

```
3. Set this key in your Virtual Environment Variables.


## 📝 License

This project is licensed under the MIT License. See the [LICENSE.md](LICENSE) file for details.

## Author

👥 **Bhupesh Varshney**

- Twitter: [@bhupeshimself](https://twitter.com/bhupeshimself)
- Github: [@Bhupesh-V](https://github.com/Bhupesh-V)

## 👋 Contributing

Please read the [CONTRIBUTING](CONTRIBUTING.md) for the process for submitting pull requests to us.
2 changes: 1 addition & 1 deletion tutorialdb/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = 'hiin&e&(d2+!7ujj^inh5*x-l1zlj!aav3sgqd)+5ka_^w31(z'
SECRET_KEY = os.environ['SECRET_KEY']

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
Expand Down

0 comments on commit 64c6507

Please sign in to comment.