Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bhupesh-v/tutorialdb

A search 🔎 engine for programming/dev tutorials,
https://github.com/bhupesh-v/tutorialdb

api dev-tool dev-tutorials developer-tools devresources devtools django django-rest-framework hacktoberfest search-engine tools tutorialdb-api tutorials tutorials-platfrom webapp

Last synced: about 1 month ago
JSON representation

A search 🔎 engine for programming/dev tutorials,

Host: GitHub
URL: https://github.com/bhupesh-v/tutorialdb
Owner: Bhupesh-V
License: mit
Created: 2019-07-11T14:42:48.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-10-01T13:48:27.000Z (about 1 year ago)
Last Synced: 2024-04-13T21:57:45.534Z (9 months ago)
Topics: api, dev-tool, dev-tutorials, developer-tools, devresources, devtools, django, django-rest-framework, hacktoberfest, search-engine, tools, tutorialdb-api, tutorials, tutorials-platfrom, webapp
Language: Python
Homepage:
Size: 658 KB
Stars: 121
Watchers: 9
Forks: 58
Open Issues: 38
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # tutorialdb 

> A search engine for programming/dev tutorials.







![GitHub release](https://img.shields.io/github/release/Bhupesh-V/tutorialdb)

[![GitHub license](https://img.shields.io/github/license/Bhupesh-V/tutorialdb)](https://github.com/Bhupesh-V/tutorialdb/blob/master/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/Bhupesh-V/tutorialdb)](https://github.com/Bhupesh-V/tutorialdb/issues)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/af7df141776744a49435a876c7b87834)](https://app.codacy.com/app/Bhupesh-V/tutorialdb?utm_source=github.com&utm_medium=referral&utm_content=Bhupesh-V/tutorialdb&utm_campaign=Badge_Grade_Dashboard)

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)

[![CodeFactor](https://www.codefactor.io/repository/github/bhupesh-v/tutorialdb/badge)](https://www.codefactor.io/repository/github/bhupesh-v/tutorialdb)

[![Maintainability](https://api.codeclimate.com/v1/badges/a4b8a52583b6706c0b3f/maintainability)](https://codeclimate.com/github/Bhupesh-V/tutorialdb/maintainability)

### About the Project 🔘

- **tutorialdb** is a small scale search engine for programming/dev tutorials, it is meant to help anyone who is getting started to learn a new technology.

- The sole purpose of tutorialdb is to help people get to resources which might help them learn new things for e.g sometimes there are tutorials on personal blogs which do not get indexed by Google easily.

- All the content (tutorials) is owned by the respective authors/sites.

- tutorialdb maintains its own database saving the links to tutorials and some meta info.

### Installation 🔮

1. Create virtual environment.

	**Linux/MacOS**

	```bash

	virtualenv -p python3 venv && cd venv && source bin/activate

	```

	**Windows**

	(*PowerShell*)

	```cmd

	py -m venv venv; .\venv\Scripts\activate;

	```

2. Clone the repository.

```bash

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

```    

3. Install dependencies.

```bash

pip install -r requirements.txt

```

4. Set-up virtual environment variables.

	1. Create a file named `.env` in the root directory & add the following contents.

	

	```text

	SECRET_KEY = 'my-secret-key'

	LOCAL_HOST = 'my-local-ip'

	```

	2. For `SECRET_KEY` use [Django Secret Key Generator](https://www.miniwebtool.com/django-secret-key-generator/) or [Djecrety](https://djecrety.ir/).

	3. Adding `LOCAL_HOST` is optional.

5. Migrate tables.

```bash

python manage.py migrate

```

6. Run Tests.

```bash

python manage.py test

```

7. Run the development server.

```bash

python manage.py runserver

```

## 📝 License

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

## 👋 Contributing

Please read the [CONTRIBUTING](CONTRIBUTING.md) file for the process of submitting pull requests to us.

## ✨ Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_MaDDogx
💻 🐛 🤔 👀 📓

    
_{Lior Shub}
💻 🐛 🎨

    
_{José Gabriel Gruber}
💻

    
_Artem
💻

    
_{Viktor Strate Kløvedal}
💻

    
_{Chris Shyi}
💻

    
_vikneswaran
💻

  

  

    
_{Adarsh Shetty}
📖

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!