Sociol

Analysts for your Social Media

📂 Technologies Used

Frontend

• NextJS
• Redux

Backend

• Django
• MongoDB Atlas

📃 Documentation

• Sprint Board on Notion

• Design Document & Test Plan

⏱ Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

📍 Prerequisites

What things you need to install the software and how to install them

• Install Yarn
• Install Node.js/npm
• Install python3/pip3 (Version >= 3.6)
• Install MongoDB
• Install MongoDB Compass (Recommended)

⛓ Installation

# Clone this repository
git clone https://github.com/CS161-SJSU/sociol.me

# Go into the repository
cd social-analytics

💡 Client Start-up

# Go into client folder
cd client

# Install client dependencies
yarn install or npm install

# Setup Environment Variables

# Create a .env file in the client folder
# Place your SPOTIFY, TWIITER, GOOGLE CLIENT/SECRET ID in the file

# Start client on localhost:3000
yarn dev or npm run dev

🔗 Server Start-up

# Create virtual environment (recommend) using conda/virtualenv
conda create --name your_env_name

# Start virtual env
source activate your_env_name

# For Windows
Create the virtual environment named "env":
python -m venv env

Add the path to the git ignore file (optional):
echo env/ >> .gitignore

Activate the virtual env:
.\env\Scripts\activate

# Setup Environment Variables

# Go into server folder
cd server

# Create a .env file in the same directory where settings.py resides
# Place your SPOTIFY, TWIITER, GOOGLE CLIENT/SECRET ID in the file

#The .env file will look like this
GOOGLE_CLIENT_ID = ".....apps.googleusercontent.com"
GOOGLE_CLIENT_SECRET = '...'
SPOTIFY_CLIENT_ID="..."
SPOTIFY_CLIENT_SECRET="..."
SPOTIFY_REDIRECT_URI="http://localhost:8000/spotify/callback"
TWITTER_ID="..."
TWITTER_SECRET="..."

# Install server packages from requirements.txt
pip3 install -r requirements.txt or python -m pip3 install -r requirements.txt

# Create new migrations
python3 manage.py makemigrations or Python manage.py makemigrations (Windows)

# Apply new migrations
python3 manage.py migrate or Python manage.py migrate (Windows)

# Start server on localhost:8000
python3 manage.py runserver or Python manage.py runserver (Windows)

⭐️ Team

👩🏻‍💻 Trinity Nguyen - trinwin (Project Lead + Frontend Lead)

👨🏻‍💻 Cagan Sevencan - cagansevencan (Frontend + Backend Developer)

👩🏻‍💻 Julia Chin - juliachin123 (Backend Developer)

👨🏻‍💻 Eric Wu - ericwu12345 (Backend Developer)

👨🏻‍💻 Toan Dao - toandaosjsu (Backend Developer)

See also the list of contributors who participated in this project.