spec-backend: A Python repository from r00ckky

SPEC NITH

Official Codebase
Report Bug · Request a Feature

📝 General Overview

This repository contains the source code of Django Backend for the official website of Society for Promotion of Electronics Culture (SPEC), NIT Hamirpur from 2021 onwards.

Visit the current official website of SPEC from here.

⚙️ Set-Up and Usage

For Linux (Debian) users:

To install the base-dependencies of the project:
```
make def
```
To install the environment with all its optional dependencies:
```
make install
```
You can use make commands to perform various operations:
- Start django server on port 8000:
```
make run
```
  Note: You can customize it default port by editing PORT variable in Makefile.
- To run the project in SECURE SSL mode, use:
```
make runssl
```
- Apply database migrations using:
```
make migrate
```
- Flush/Clear database records:
```
make flush
```
  Note: Media files will not be deleted using this command
- Check for proper formatting and sort imports using:
```
make format
```
- To run Django Test-Suite:
```
make test
```
- To run all formatting and coverage tests:
```
make check
```

For Windows users:

To set up the environment:
```
.\make.bat install
```
To activate the virtual environment
```
./Scripts/Activate.ps1
```

Note: All the make commands are same as in GNU, the difference ensues from how they are called. For example:

For Linux:
```
make run
```
For Windows:
```
.\make run
```

🎯 Contributing Guidelines

Contributions are what make the open source community such an amazing place to learn, inspire and build experiences that are cherished for a lifetime. Go ahead and follow these steps to contribute to the community.

Fork this repository by clicking on Fork button on the top right side.

Clone your Fork to your local machine

git clone [git@github.com:spec-nith/spec-backend.git]

Create your Feature Branch
```
git checkout -b [branch-name]
```

Make your changes and commit them

git add . 
git commit -m "Add some amazing feature"