README.md

tutorialdb

A search engine for programming/dev tutorials.

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

3. Install dependencies.

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.

   SECRET_KEY = 'my-secret-key'
   LOCAL_HOST = 'my-local-ip'
   

   2. For SECRET_KEY use Django Secret Key Generator or Djecrety.
   3. Adding LOCAL_HOST is optional.

5. Migrate tables.

python manage.py migrate

6. Run Tests.

python manage.py test

7. 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!