Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/daffafaizan/assignment-2-repo


https://github.com/daffafaizan/assignment-2-repo

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# PBP Django Project Template



Platform-Based Programming (CSGE602022) - Organized by the Faculty of Computer Science Universitas Indonesia, Odd Semester 2022/2023



*Read this in other languages: [Indonesian](README.md), [English](README.en.md)*



## Introduction



This repository is a template that is designed to help students who take the Platform-Based Development/Programming Course (CSGE602022) to know the structure of a Django Web application project, including the files and configurations that are important in running the application. You can freely copy the contents of this repository or utilise this repository as a learning material and also as a starting code to build a Django Web application project.



## How to Use



If you want to use the code template in this repository as a starter code for

developing a Django Web application:



1. Open the GitHub page of the code template repository and click "**Use this template**"

   button to make a copy of the repository into your own GitHub account.

2. Clone the new Django template repository from your GitHub account to a

   location in the filesystem of your local development environment by using

   Git:



   ```shell

   git clone  

   ```

3. Go to the location where the cloned repository is located in the local

   development environment:



   ```shell

   cd 

   ```

4. Create a Python virtual environment named `env` inside the cloned repository

   by using Python's `venv` module:



   ```shell

   python -m venv env

   ```

5. Activate the virtual environment:



   ```shell

   # Windows

   .\env\Scripts\activate

   # Linux/Unix, e.g. Ubuntu, MacOS

   source env/bin/activate

   ```

6. Verify the virtual environment has been activated by looking at the prompt

   of your shell. Make sure there is a `env` prefix in your shell. For example:



   ```shell

   # Windows using `pwsh` shell

   (env) PS C:\Users\RickeyAstley\my-django-app

   # Linux/Unix, e.g. Ubuntu using `bash` shell

   (env) rickeyastley@ubuntu:~/my-django-app

   ```



   > Note: You can use [Visual Studio Code][] (with Python extension) or [PyCharm][]

   > to open the source code directory that has a virtual environment directory.

   > Both will detect the virtual environment and use the correct Python virtual

   > environment. Furthermore, you can also run your shell directly in both text

   > editor/IDE.

7. Install the dependencies needed to build, test, and run the application:



   ```shell

   pip install -r requirements.txt

   ```

8. Run the Django Web application using local development server:



   ```shell

   python manage.py runserver

   ```

9. Open http://localhost:8000 in your favourite Web browser to see if the Web

   application is running.



## Deployment Example



The code template provided a GitHub workflow to deploy the sample Django Web

application to [Heroku][], which is a Platform-as-a-Service (PaaS) provider

that lets you to build and run a Web application on their infrastructure. You

can read the instructions at [Tutorial 0][] to figure out how to configure the

GitHub Actions to run the provided workflow in your repository.



For reference, the deployed Django Web application example from the original

code template repository can be found at: https://django-pbp-template.herokuapp.com.



## Next Actions



If you have successfully created your own repository and set up the Django Web

application project, you can start working on the weekly tutorials and assignments

related to Django Web application development. 



If you found any issues or have ideas to improve the code template, feel free

to discuss your proposal via the [issue tracker](https://github.com/pbp-fasilkom-ui/django-pbp-template/issues)

and create a Pull Request (PR) containing your changes to the code template.



## Credits



This template was based on [PBP Odd Term 2021/2022](https://gitlab.com/PBP-2021/pbp-lab) written by 2021 Platform Based Programming Teaching Team ([@prakashdivyy](https://gitlab.com/prakashdivyy)) and [django-template-heroku](https://github.com/laymonage/django-template-heroku) written by [@laymonage, et al.](https://github.com/laymonage). This template is designed in such a way so that students can use this template as a starter and reference in doing assignments and their work.



[Heroku]: https://www.heroku.com/

[Tutorial 0]: https://pbp-fasilkom-ui.github.io/ganjil-2023/en/assignments/tutorial/tutorial-0

[Visual Studio Code]: https://code.visualstudio.com/

[PyCharm]: https://www.jetbrains.com/pycharm/