Welcome to the installation guide for BUCK$. Follow these steps to set up the project on your system.
Before you begin, ensure you have the following installed:
- Python (version 3.10 or higher)
- Node.js (version 16 or higher)
- Git
- MySQL
-
Clone the repository:
git clone https://github.com/CSC493-Computing-Design-Practicum/csc493-cdp-stevensonmichel.gitcd csc493-cdp-stevensonmichel.git/backend -
Set up a virtual environment:
python -m venv yourvirtualenvironmentsource yourvirtualenvironment/bin/activate -
Install dependencies:
pip install -r requirements.txt -
Create a new MySQL database.
- Access MySQL CLI:
mysql -u root -p-
Replace root with your MySQL username, if different.
-
Enter your MySQL password when prompted.
-
Create your database
CREATE DATABASE IF NOT EXISTS project_db;USE project_db;CREATE USER IF NOT EXISTS 'project_user'@'localhost' IDENTIFIED BY 'password';GRANT ALL PRIVILEGES ON project_db.* TO 'project_user'@'localhost';FLUSH PRIVILEGES;
-
Update the DATABASES section in
backend/bucks/settings.pywith your database credentials.DATABASES = {'default': {'ENGINE': 'django.db.backends.mysql','NAME': 'project_db','USER': 'project_user','PASSWORD': 'password','HOST': 'localhost','PORT': '3306',}} -
Apply migrations:
python manage.py makemigrationspython manage.py migrate -
Run the server backend server:
python manage.py runserver
-
Navigate to the frontend directory:
cd codebase/frontend -
Install dependencies:
npm install -
Start the development server with:
npm start