This repository contains code of the website currently live at http://iste.nitk.ac.in. The website allows members of the club to showcase their projects, add details of upcoming events, conduct recruitments. The website also serves as a data store of all club members.
The backend of the website runs on the popular Python framework - Django.
The frontend of the website heavily relies on MaterialCSS, an open source material design framework which runs on top of React JS library.
Although the website is maintained solely by members of Crypt, members of other SIGs are welcome to send in pull requests to address
Note: pull requests out of order of instructions mentioned will not be entertained.
Open issues.
Before contributing to the repository, go through
CONTRIBUTING.md
- Python 3.8
- Node.js 16 (via NVM)
- SQLite database file
- Install Python 3.8
# Check Python version after installation
python3.8 --version- Create and activate virtual environment
# Create virtual environment
python3.8 -m venv venv
# Activate virtual environment
# On Windows
venv\Scripts\activate
# On macOS/Linux
source venv/bin/activate- Install dependencies
pip install -r requirements.txt- Set up database
- Copy your SQLite database file to the backend directory
- Ensure the file has proper read/write permissions
- Run backend server
python3.8 manage.py runserverThe backend server should now be running at http://localhost:8000
- Install Node.js 16 using NVM
# Install NVM if not already installed
# See https://github.com/nvm-sh/nvm for installation instructions
# Install Node.js 16
nvm install 16
nvm use 16- Navigate to frontend directory and install dependencies
cd frontend
npm install --legacy-peer-deps- Start frontend development server
npm startThe frontend application should now be running at http://localhost:3000