Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
Added bug report template
  • Loading branch information
Prater-12 committed Oct 15, 2023
1 parent 77796ef commit 2c3c0fd
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 4 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: "bug"
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]

**Additional context**
Add any other context about the problem here.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

#### This repository is a part of HelloFOSS '23

An on-going project of the Web and Coding Club.
An on-going project of the Web and Coding Club. Built using Django REST Framework and React.

# Usage

Expand All @@ -18,21 +18,24 @@ Install JS packages

```shell
cd frontend
# npm stuff here
npm install
```

Create Virtual Environment:

```shell
cd backend
python3 -m venv .venv
python3 -m venv venv
./venv/Scripts/Activate.ps1 # Windows
# Linux/MacOS
pip3 install -r requirements.txt
```

Run Application

```shell
# Frontend
# Frontend (in ./frontend/)
npm run start
# Backend (in ./backend/)
python manage.py runserver
```
Expand Down

0 comments on commit 2c3c0fd

Please sign in to comment.