andhrelja / timetabled Goto Github PK

Few lines describing your project.

Your project’s name is the first thing people will see upon scrolling down to your README, and is included upon creation of your README file.

Optionally, include a table of contents in order to allow other people to quickly navigate especially long or detailed READMEs.

Kloniranjem se pokreće download repozitorija u direktorij iz kojeg je zadana git clone komanda.

  $ git clone https://github.com/andhrelja/timetabled
  $ pip install -r requirements.txt && cd src/ 
  # python manage.py runserver

Provjeru uspješne instalacije moguće je obaviti pokretanjem requirements_check.py Python skripte u root folderu repozitorija.

Ovako pokrenuti lokalni server, bez izmjena u src/timetabled/settings.py datoteci, spojen je na Heroku bazu s informacijama o konekciji dostupnima u src/settings.py datoteci unutar sekcije # Database.

Tamo su dostupne dvije konfiguracije. Konfiguracija s HOST postavljenim na localhost pokazuje na lokalnu bazu koju je potrebno stvoriti manualno instalacijom PostgreSQL baze (verzija 12.5) na lokalno računalo.

Dodatak instalaciji je DBMS alat pgAdmin dostupan na službenim stranicama (najnovija verzija), a može se koristiti bilo koji drugi DBMS alat (Dbeaver, MySQL Workbench, phpMyAdmin, ...).

The next section is usage, in which you instruct other people on how to use your project after they’ve installed it. This would also be a good place to include screenshots of your project in action.

Larger projects often have sections on contributing to their project, in which contribution instructions are outlined. Sometimes, this is a separate file. If you have specific contribution preferences, explain them so that other developers know how to best contribute to your work. To learn more about how to help others contribute, check out the guide for setting guidelines for repository contributors.

Include a section for credits in order to highlight and link to the authors of your project.

Finally, include a section for the license of your project. For more information on choosing a license, check out GitHub’s licensing guide!

Your README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis, outlined below.