Skip to content

A search ๐Ÿ”Ž engine for programming/dev tutorials,

License

Notifications You must be signed in to change notification settings

Bhupesh-V/tutorialdb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

tutorialdb

A search engine for programming/dev tutorials.

GitHub release GitHub license GitHub issues Codacy Badge All Contributors CodeFactor 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

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

    Windows (PowerShell)

    py -m venv venv; .\venv\Scripts\activate;
  2. Clone the repository.

git clone https://github.com/Bhupesh-V/tutorialdb.git
  1. Install dependencies.
pip install -r requirements.txt
  1. Set-up virtual environment variables.

    1. Create a file named .env in the root directory & add the following contents.
    SECRET_KEY = 'my-secret-key'
    LOCAL_HOST = 'my-local-ip'
    
    1. For SECRET_KEY use Django Secret Key Generator or Djecrety.
    2. Adding LOCAL_HOST is optional.
  2. Migrate tables.

python manage.py migrate
  1. Run Tests.
python manage.py test
  1. Run the development server.
python manage.py runserver

๐Ÿ“ License

This project is licensed under the MIT License. See the LICENSE.md file for details.

๐Ÿ‘‹ Contributing

Please read the CONTRIBUTING file for the process of submitting pull requests to us.

โœจ Contributors

Thanks goes to these wonderful people (emoji key):


MaDDogx

๐Ÿ’ป ๐Ÿ› ๐Ÿค” ๐Ÿ‘€ ๐Ÿ““

Lior Shub

๐Ÿ’ป ๐Ÿ› ๐ŸŽจ

Josรฉ Gabriel Gruber

๐Ÿ’ป

Artem

๐Ÿ’ป

Viktor Strate Klรธvedal

๐Ÿ’ป

Chris Shyi

๐Ÿ’ป

vikneswaran

๐Ÿ’ป

Adarsh Shetty

๐Ÿ“–

This project follows the all-contributors specification. Contributions of any kind welcome!